PHPackages                             solutiondrive/hipchat-v2-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. solutiondrive/hipchat-v2-api-client

AbandonedArchivedLibrary[API Development](/categories/api)

solutiondrive/hipchat-v2-api-client
===================================

Hipchat v2 API client

v2.0.1(8y ago)311.2k3MITPHPPHP &gt;=5.6

Since Jul 12Pushed 8y ago4 watchersCompare

[ Source](https://github.com/solutionDrive/HipchatAPIv2Client)[ Packagist](https://packagist.org/packages/solutiondrive/hipchat-v2-api-client)[ Docs](https://github.com/gorkalaucirica/HipchatAPIv2Client)[ RSS](/packages/solutiondrive-hipchat-v2-api-client/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)Dependencies (3)Versions (12)Used By (0)

Hipchat v2 Api Client
=====================

[](#hipchat-v2-api-client)

Based on [**gorkalaucirica/HipchatAPIv2Client**](https://github.com/gorkalaucirica/HipchatAPIv2Client)

PHP Library to process calls to Hipchat's v2 REST API

[![Latest Stable Version](https://camo.githubusercontent.com/75af4ae5de9c8471fee0610d072dd7cfef8bebade7f9cd177de7c90b5c6253fc/68747470733a2f2f706f7365722e707567782e6f72672f736f6c7574696f6e64726976652f686970636861742d76322d6170692d636c69656e742f762f737461626c65)](https://packagist.org/packages/solutiondrive/hipchat-v2-api-client)[![Total Downloads](https://camo.githubusercontent.com/8bed138a4559ace5d88442a583fcb84756ebaa166b604b8a1bad56682ce488af/68747470733a2f2f706f7365722e707567782e6f72672f736f6c7574696f6e64726976652f686970636861742d76322d6170692d636c69656e742f646f776e6c6f616473)](https://packagist.org/packages/solutiondrive/hipchat-v2-api-client)[![Latest Unstable Version](https://camo.githubusercontent.com/cf9d1e472dd1eaef5e4a3810b12c97d3b611f3c45c4fbc53c9b4731b3c68a6a1/68747470733a2f2f706f7365722e707567782e6f72672f736f6c7574696f6e64726976652f686970636861742d76322d6170692d636c69656e742f762f756e737461626c65)](https://packagist.org/packages/solutiondrive/hipchat-v2-api-client)[![License](https://camo.githubusercontent.com/32b34e2cc5d3994eb40a9a95ee49992d98a84a3117d02d316e7f31583254e775/68747470733a2f2f706f7365722e707567782e6f72672f736f6c7574696f6e64726976652f686970636861742d76322d6170692d636c69656e742f6c6963656e7365)](https://packagist.org/packages/solutiondrive/hipchat-v2-api-client)[![Build Status](https://camo.githubusercontent.com/2358353acc95ea4b38e4d30bc2b85f3798b9166ee950eab3011247cead502df2/68747470733a2f2f7472617669732d63692e6f72672f736f6c7574696f6e44726976652f486970636861744150497632436c69656e742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/solutionDrive/HipchatAPIv2Client)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/2cac8106ab586267496e4ee1dbfc04901945650ef5383c7f359efcfc05407459/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f736f6c7574696f6e44726976652f486970636861744150497632436c69656e742f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/solutionDrive/HipchatAPIv2Client/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/897d760295df101ce4991e6da5f922afca4c39b561910e1b3b90ad01479bf721/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f736f6c7574696f6e44726976652f486970636861744150497632436c69656e742f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/solutionDrive/HipchatAPIv2Client/?branch=master)[![SensioLabsInsight](https://camo.githubusercontent.com/80f694a46f80c8461e47de47b42272da04ef669dd47aac04b55b905c661f86b0/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f66653164646534662d333135382d343564622d386639612d3331356639376632636435342f6d696e692e706e67)](https://insight.sensiolabs.com/projects/fe1dde4f-3158-45db-8f9a-315f97f2cd54)

*This package is work in progress and some functionality is not available yet.*

Installation
------------

[](#installation)

The recommended way to install Hipchatv2ApiClient is through [Composer](https://getcomposer.org). To install this library, run the command below and you will get the latest version:

```
composer require solutiondrive/hipchat-v2-api-client

```

Usage
-----

[](#usage)

All queries need the following two lines. The first one is to authenticate yourself and the second one creates a client that is used by the API classes to perform requests to the API. That is enough to start, now check the API calls section to see how to use the `$client` to send requests to the API.

```
use SolutionDrive\HipchatAPIv2Client\Auth\OAuth2;
use SolutionDrive\HipchatAPIv2Client\Client;

$auth = new OAuth2('tokenYouCanGetInHipchatSite');
$client = new Client($auth);

```

Client for private instances
----------------------------

[](#client-for-private-instances)

After version 1.5.0 you can set the URL in the constructor to change the base url used by the client (by default uses `https://api.hipchat.com`

```
$client = new Client($auth, null, 'https.//api.yourdomain.com');

```

API calls
---------

[](#api-calls)

All API call methods are located in the API folder. All of them have been documented and all have a link to Hipchat v2 API documentation. Some examples:

#### Getting user by mention name:

[](#getting-user-by-mention-name)

```
use SolutionDrive\HipchatAPIv2Client\API\UserAPI;

$userAPI = new UserAPI($client);
$user = $userAPI->getUser('@gorkalaucirica');

```

#### Getting all rooms

[](#getting-all-rooms)

```
use SolutionDrive\HipchatAPIv2Client\API\RoomAPI;

$roomAPI = new RoomAPI($client);
$room = $roomAPI->getRooms(array('max-results' => 30));

```

Current status
--------------

[](#current-status)

The following list shows methods available and missing:

#### Add ons / Integrations

[](#add-ons--integrations)

- [Get addon installable data](https://www.hipchat.com/docs/apiv2/method/get_integration_installable_data)
- [Create addon link](https://www.hipchat.com/docs/apiv2/method/create_integration_link)
- [Invoke addon link](https://www.hipchat.com/docs/apiv2/method/invoke_integration_link)
- [Delete addon link](https://www.hipchat.com/docs/apiv2/method/delete_integration_link)
- [Addon ui update](https://www.hipchat.com/docs/apiv2/method/addon_ui_update)
- [Room addon ui update](https://www.hipchat.com/docs/apiv2/method/room_addon_ui_update)
- [User in room addon ui update](https://www.hipchat.com/docs/apiv2/method/user_in_room_addon_ui_update)
- [User addon ui update](https://www.hipchat.com/docs/apiv2/method/user_in_room_addon_ui_update)

#### Capabilities

[](#capabilities)

- Get capabilities

#### Emoticons

[](#emoticons)

- Get emoticon
- Get all emoticons

#### OAuth Sessions

[](#oauth-sessions)

- Generate token
- Get session
- Delete session

#### Rooms

[](#rooms)

- Get all rooms
- Create room
- Get room
- Update room
- Delete room
- Get avatar
- Update avatar
- Delete avatar
- Get room message
- View room history
- View recent room history
- Invite user
- Add member
- Remove member
- Get all members
- Send message
- Send room notification
- Get all participants
- Reply to message
- Share file with room
- Get room statistics
- Set topic
- Get webhook
- Delete webhook
- Get all webhooks
- Create webhook

#### Users

[](#users)

- Get all users
- Create user
- View user
- Update user
- Delete user
- Get privatechat message
- View recent privatechat history
- Private message user
- Get photo
- Upload photo
- Delete photo
- Get auto join rooms
- Share file with user
- Share link with user

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community24

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 57.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~127 days

Recently: every ~251 days

Total

11

Last Release

3048d ago

Major Versions

v1.5.1 → v2.0.02017-12-03

PHP version history (2 changes)v1.0.0PHP &gt;=5.3.3

v2.0.0PHP &gt;=5.6

### Community

Maintainers

![](https://www.gravatar.com/avatar/667b5107f4c2ea180baa00166c2ee3f2a1b412ce22768d6e81bb09323d1c7fe0?d=identicon)[netlogix](/maintainers/netlogix)

![](https://www.gravatar.com/avatar/9c04fbc5922166132f9ded7b5d8efdfcc57f20deb1837bf38ed081327343993a?d=identicon)[sd\_alt](/maintainers/sd_alt)

![](https://avatars.githubusercontent.com/u/16880583?v=4)[Tobias Lückel](/maintainers/sd-lueckel)[@sd-lueckel](https://github.com/sd-lueckel)

![](https://www.gravatar.com/avatar/a4b576421ecba084a2b7bac74e3ce54476b44e80da0aa89bfc3e19a84115735a?d=identicon)[twojtylak](/maintainers/twojtylak)

![](https://www.gravatar.com/avatar/24edefe3f5deaace871051bc6206adf207954d2bf5f45b8ca56b096287b85597?d=identicon)[nlx-vladi](/maintainers/nlx-vladi)

![](https://www.gravatar.com/avatar/774d994f0c68da56719c96d83499828a32d5dd2e4931a7986e335750b13daf2f?d=identicon)[michz](/maintainers/michz)

---

Top Contributors

[![gorkalaucirica](https://avatars.githubusercontent.com/u/1749891?v=4)](https://github.com/gorkalaucirica "gorkalaucirica (41 commits)")[![zionsg](https://avatars.githubusercontent.com/u/2634318?v=4)](https://github.com/zionsg "zionsg (9 commits)")[![fabianderschatta](https://avatars.githubusercontent.com/u/6513855?v=4)](https://github.com/fabianderschatta "fabianderschatta (3 commits)")[![andyfitch](https://avatars.githubusercontent.com/u/265406?v=4)](https://github.com/andyfitch "andyfitch (3 commits)")[![andypoorman](https://avatars.githubusercontent.com/u/916094?v=4)](https://github.com/andypoorman "andypoorman (3 commits)")[![anvyst](https://avatars.githubusercontent.com/u/227261?v=4)](https://github.com/anvyst "anvyst (3 commits)")[![eleclerc](https://avatars.githubusercontent.com/u/26734?v=4)](https://github.com/eleclerc "eleclerc (2 commits)")[![AntoineLemaire](https://avatars.githubusercontent.com/u/2025537?v=4)](https://github.com/AntoineLemaire "AntoineLemaire (2 commits)")[![acedude](https://avatars.githubusercontent.com/u/2816665?v=4)](https://github.com/acedude "acedude (1 commits)")[![JosephBlock](https://avatars.githubusercontent.com/u/3733445?v=4)](https://github.com/JosephBlock "JosephBlock (1 commits)")[![ROunofF](https://avatars.githubusercontent.com/u/5734058?v=4)](https://github.com/ROunofF "ROunofF (1 commits)")[![TSchuermans](https://avatars.githubusercontent.com/u/671116?v=4)](https://github.com/TSchuermans "TSchuermans (1 commits)")[![amochohan](https://avatars.githubusercontent.com/u/2978619?v=4)](https://github.com/amochohan "amochohan (1 commits)")

---

Tags

apiclientlibraryv2hipchat

### Embed Badge

![Health badge](/badges/solutiondrive-hipchat-v2-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/solutiondrive-hipchat-v2-api-client/health.svg)](https://phpackages.com/packages/solutiondrive-hipchat-v2-api-client)
```

###  Alternatives

[gorkalaucirica/hipchat-v2-api-client

Hipchat v2 API client

80223.4k6](/packages/gorkalaucirica-hipchat-v2-api-client)[teknoo/sellsy-client

PHP library to connect your applications to your Sellsy account account using the Sellsy API and build your websites and your platforms on the Sellsy technology.

18195.6k](/packages/teknoo-sellsy-client)[fabian-beiner/todoist-php-api-library

A PHP client library that provides a native interface to the official Todoist REST API.

4810.8k](/packages/fabian-beiner-todoist-php-api-library)[tilleuls/amazon-mws-orders

Amazon Marketplace Web Service Orders PHP Client Library

1288.1k1](/packages/tilleuls-amazon-mws-orders)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
