This a very simple HipChat API optimized for Laravel & Lumen version 5.
From the command line, run:
composer require bestit/hipchat-api
From the command line, run:
php artisan vendor:publish --provider HipChatServiceProvider
For your Laravel app, open config/app.php
and, within the providers
array, append:
Bestit\HipChat\HipChatServiceProvider::class,
This will bootstrap the package into Laravel.
For your Laravel app, open config/app.php
and, within the aliases
array, append:
'HipChat' => Bestit\HipChat\Facade\HipChat::class,
This will add the HipChat Facade into Laravel.
Add the following entries to your environment (.env) file:
HIPCHAT_SERVER_URL // This is optional, defaults to 'https://api.hipchat.com'
HIPCHAT_API_TOKEN // This is required, use a user personal token.
Inside your bootstrap/app.php file, add:
$app->register(Bestit\HipChat\HipChatLumenServiceProvider::class);
Copy the vendor/bestit/hipchat-api/src/config/hipchat.php
file to your local config directory (if it does not exist yet, you have to create it) and don't forget add the entries to your environment (.env) file described in Step 4 of the Laravel Configuration.
-
Notification in a Room
HipChat::room('RoomNameOrRoomId')->notify('Some Cool Message'); // you have three optional parameters, `color`, `alert` and `notify`
Read more: here
-
Notification to a user
HipChat::user('UserEmailOrId')->notify('Some Cool Message'); // you have two optional parameters, `alert` and `format`
Read more: here
$url = 'https://company.hipchat.com'; // Can be left empty, default to https://api.hipchat.com
$token = 'some_api_token';
$client = new \Bestit\HipChat\Client($token, $url);
$client->room('RoomNameOrRoomId')->notify('Some Cool Message');
$client->user('UserEmailOrId')->notify('Some Cool Message');
- Cover more API Endpoints
- Tests
- Cleanup/Interfaces etc.
- Travis CI