PHPackages laravel-notification-channels/hipchat - 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. [Mail & Notifications](/categories/mail) 4. / 5. laravel-notification-channels/hipchat AbandonedArchivedLibrary[Mail & Notifications](/categories/mail) laravel-notification-channels/hipchat ===================================== HipChat Notifications Channel for Laravel v2.2.0(7y ago)1834.8k101MITPHPPHP >=5.6.4 Since Aug 15Pushed 6y ago4 watchersCompare [ Source](https://github.com/laravel-notification-channels/hipchat)[ Packagist](https://packagist.org/packages/laravel-notification-channels/hipchat)[ Docs](https://github.com/laravel-notification-channels/hipchat)[ RSS](/packages/laravel-notification-channels-hipchat/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (6)Versions (11)Used By (1) HipChat Notifications Channel for Laravel ========================================= [](#hipchat-notifications-channel-for-laravel) [![Latest Version on Packagist](https://camo.githubusercontent.com/a348bff964604226cfc955f5d789b16d3db5343d83d833a0d74a2b1539ff4c78/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6c61726176656c2d6e6f74696669636174696f6e2d6368616e6e656c732f686970636861742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/laravel-notification-channels/hipchat)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/0dcd20c88064b39f154391b8194488c8a84948d6277bcbc8e519e89021864b8a/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6c61726176656c2d6e6f74696669636174696f6e2d6368616e6e656c732f686970636861742f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/laravel-notification-channels/hipchat)[![StyleCI](https://camo.githubusercontent.com/a8da12df10be0a8d9fab3038a7d7d82640fcaffea4cdbf2f60d448f4e9b62254/68747470733a2f2f7374796c6563692e696f2f7265706f732f36353731343636302f736869656c64)](https://styleci.io/repos/65714660)[![SensioLabsInsight](https://camo.githubusercontent.com/ce782b2f121ea243557599bbef0b9e65ed4224acab9e2180a107f17cc6983873/68747470733a2f2f696d672e736869656c64732e696f2f73656e73696f6c6162732f692f31616639636665642d653632642d343035612d623036642d3930373164326638626565382e7376673f7374796c653d666c61742d737175617265)](https://insight.sensiolabs.com/projects/1af9cfed-e62d-405a-b06d-9071d2f8bee8)[![Quality Score](https://camo.githubusercontent.com/13bd39fd327d51996084557b024ab3a8e4d3982b22619c865004ad5b32e4e2e9/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6c61726176656c2d6e6f74696669636174696f6e2d6368616e6e656c732f686970636861742e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/laravel-notification-channels/hipchat)[![Code Coverage](https://camo.githubusercontent.com/350f5fb1176aceacd1f04dbea3ff49a989693b3cb644934c5f09323f9d79b462/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f6c61726176656c2d6e6f74696669636174696f6e2d6368616e6e656c732f686970636861742f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/laravel-notification-channels/hipchat/?branch=master)[![Total Downloads](https://camo.githubusercontent.com/7b2f4de56dd6d1b7d87f075d4c788661e731893ce9148fe1820359f146957d30/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6c61726176656c2d6e6f74696669636174696f6e2d6368616e6e656c732f686970636861742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/laravel-notification-channels/hipchat) This package makes it easy to send [HipChat notifications](https://www.hipchat.com) with Laravel. Channel Deprecated ================== [](#channel-deprecated) Hipchat was [discontinued in early 2019](https://www.atlassian.com/partnerships/slack). As such, this channel will no longer receive updates and is being deprecated. Contents -------- [](#contents) - [Installation](#installation) - [Setting up the HipChat Service](#setting-up-the-hipchat-service) - [Usage](#usage) - [Sending a simple room notification](#sending-a-simple-room-notification) - [Sending a room notification with a card](#sending-a-room-notification-with-a-card) - [Sharing a file in a HipChat room](#sharing-a-file-in-a-hipchat-room) - [Available methods](#available-methods) - [Testing](#testing) - [Security](#security) - [Changelog](#changelog) - [Contributing](#contributing) - [Credits](#credits) - [License](#license) Installation ------------ [](#installation) You can install the package via composer: ``` composer require laravel-notification-channels/hipchat ``` If you're using Laravel < 5.5 or if you have package auto-discovery turned off you have to manually register the service provider: ``` // config/app.php 'providers' => [ ... NotificationChannels\HipChat\HipChatServiceProvider::class, ], ``` ### Setting up the HipChat service [](#setting-up-the-hipchat-service) Add your HipChat Account Token and optionally the default room and Hipchat API server's base url to your `config/services.php`: ``` // config/services.php ... 'hipchat' => [ 'token' => env('HIPCHAT_TOKEN'), // Default room (optional) 'room' => 'Notifications', // Base URL for Hipchat API server (optional) 'url' => 'https://api.your.hipchat.server.com', ], ... ``` Usage ----- [](#usage) ### Sending a simple room notification [](#sending-a-simple-room-notification) > ***Note**: In order to be able to send room notifications you would need an auth token (both personal and room tokens will work) with the [send\_notification](https://developer.atlassian.com/hipchat/guide/hipchat-rest-api/api-scopes) scope.* ``` use NotificationChannels\HipChat\HipChatChannel; use NotificationChannels\HipChat\HipChatMessage; use Illuminate\Notifications\Notification; class UserRegistered extends Notification { public function via($notifiable) { return [HipChatChannel::class]; } public function toHipChat($notifiable) { return HipChatMessage::create() ->room('New Registrations') ->html("A new user has registered!") ->success() ->notify(); } } ``` ### Sending a room notification with a card [](#sending-a-room-notification-with-a-card) Read more about HipChat notification cards [here](https://developer.atlassian.com/hipchat/guide/sending-messages#SendingMessages-UsingCards). ``` public function toHipChat($notifiable) { return HipChatMessage::create() ->text('Laravel 5.3 has arrived!') ->notify(true) ->card(Card::create() ->title('Laravel') ->style(CardStyles::APPLICATION) ->url('http://laravel.com') ->html('Laravel 5.3 has arrived! The best release ever!') ->cardFormat(CardFormats::MEDIUM) ->icon('http://bit.ly/2c7ntiF') ->activity('Laravel 5.3 has arrived!', 'http://bit.ly/2c7ntiF') ->addAttribute(CardAttribute::create() ->label('Laravel Scout') ->icon('http://bit.ly/2c7ntiF') ->value('Driver based full-text search.') ->url('https://laravel.com/docs/5.3/scout') ) ->addAttribute(CardAttribute::create() ->label('Laravel Echo') ->icon('http://bit.ly/2c7ntiF') ->value('Event broadcasting, evolved.') ->url('https://laravel.com/docs/5.3/broadcasting') ) ->addAttribute(CardAttribute::create() ->label('Laravel Passport') ->icon('http://bit.ly/2c7ntiF') ->value('API authentication.') ->url('https://laravel.com/docs/5.3/passport') ) ); } ``` ### Sharing a file in a HipChat room [](#sharing-a-file-in-a-hipchat-room) > ***Note**: In order to be able to share files you would need an auth token (i.e. personal token) with the [send\_message](https://developer.atlassian.com/hipchat/guide/hipchat-rest-api/api-scopes) scope. You can create such token by visiting HipChat -> Account Setting -> API Access.* In majority of cases all you need is just a path to an exisiting file you want to share ``` public function toHipChat($notifiable) { return HipChatFile::create($this->user->photo); } ``` You can optionally send a text message along the way ``` public function toHipChat($notifiable) { return HipChatFile::create($this->user->photo); ->text("Look we've got a new user!"); } ``` If you need more control and/or you're creating the content of the file on the fly ``` public function toHipChat($notifiable) { return HipChatFile::create() ->fileName('user_photo.png') ->fileType('image/png') ->fileContent(fopen('http://example.com/user/photo/johndoe', 'r')) ->text("Look we've got a new user!"); } ``` ### Available methods [](#available-methods) #### `HipChatMessage` [](#hipchatmessage) - `create()`: Creates a new `HipChatMessage` instance. - `room()`: Sets the id or name of the HipChat room to send the notification to. - `from()`: Sets the optional label to be shown in addition to the sender's name. - `content()`: Sets the content of the notification message. - `text()`: Sets the format to plain text and optionally the content. - `html()`: Sets the format to html and optionally the content. Allowed HTML tags: a, b, i, strong, em, br, img, pre, code, lists, tables. - `color()`: Sets the color of the message. See `MessageColors` for allowec values. - `notify()`: Specifies if a message should trigger a user notification in a Hipchat client. - `info()`: Sets notification level to `info` and color to `MessageColors::GRAY`. - `success()`: Sets notification level to `success` and color to `MessageColors::GREEN`. - `error()`: Sets notification level to `info` and color to `MessageColors::RED`. #### `Card` [](#card) - `create()`: Creates a new `Card` instance. - `title()`: Sets the title of the card. - `id()`: Sets the id of the card. - `style()`: Sets the style of the card. See `CardStyles` for allowed values. - `text()`: Sets the format to plain text and optionally the content. - `html()`: Sets the format to html and optionally the content. - `cardFormat()`: Sets the format of the card. See `CardFormats` for allowed values. - `url()`: Sets the url of the card. - `thumbnail()`: Sets the thumbnail of the card. - `activity()`: Sets the activity info of the card. - `icon()`: Sets the icon of the card. - `addAttribute()`: Adds a `CardAttribute` to the card. #### `CardAttribute` [](#cardattribute) - `create()`: Creates a new `CardAttribute` instance. - `value()`: Sets the textual value of the attribute. - `label()`: Sets the label of the attribute. - `url()`: Sets the url of the attribute. - `style()`: Sets the style of the attribute. See `CardAttributeStyles` for allowed values. - `icon()`: Sets the icon of the attribute. #### `HipChatFile` [](#hipchatfile) - `create()`: Creates a new `HipChatFile` instance. - `room()`: Sets the id or name of the HipChat room to share the file in. - `path()`: Sets the `fileContent` to the resource of the existing file and tries to detect and set the `fileName` and `fileType` if they weren't explicitely set. - `fileName`: Sets the name of the file. - `fileContent`: Explicitely sets the content of the file. It can be a string, stream or a file resource. If a resource was passed it tries to detect and set the `fileType` if it wasn't explicitely set. - `fileType`: Explicitely sets the content (mime) type of the file. - `text()`: Sets a text message to be sent along with the file. Testing ------- [](#testing) ``` $ composer test ``` Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Credits ------- [](#credits) - [Peter Matseykanets](https://github.com/pmatseykanets) - [All Contributors](../../contributors) Special thanks to [Jerry Price](https://github.com/jjpmann) for his help. License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 38 — LowBetter than 85% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity34 Limited adoption so far Community23 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 69.1% 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 ~92 days Recently: every ~165 days Total 10 Last Release 2729d ago Major Versions 0.2.0 → 1.0.02017-09-02 1.0.0 → v2.0.02018-02-12 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/20937037?v=4)[Laravel Notification Channels](/maintainers/laravel-notification-channels)[@laravel-notification-channels](https://github.com/laravel-notification-channels) --- Top Contributors [![pmatseykanets](https://avatars.githubusercontent.com/u/779965?v=4)](https://github.com/pmatseykanets "pmatseykanets (56 commits)")[![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (12 commits)")[![themsaid](https://avatars.githubusercontent.com/u/4332182?v=4)](https://github.com/themsaid "themsaid (3 commits)")[![michaeldyrynda](https://avatars.githubusercontent.com/u/558441?v=4)](https://github.com/michaeldyrynda "michaeldyrynda (2 commits)")[![mpociot](https://avatars.githubusercontent.com/u/804684?v=4)](https://github.com/mpociot "mpociot (2 commits)")[![atymic](https://avatars.githubusercontent.com/u/50683531?v=4)](https://github.com/atymic "atymic (1 commits)")[![ybr-nx](https://avatars.githubusercontent.com/u/832778?v=4)](https://github.com/ybr-nx "ybr-nx (1 commits)")[![casperboone](https://avatars.githubusercontent.com/u/15815208?v=4)](https://github.com/casperboone "casperboone (1 commits)")[![lbausch](https://avatars.githubusercontent.com/u/5747127?v=4)](https://github.com/lbausch "lbausch (1 commits)")[![oyed](https://avatars.githubusercontent.com/u/172114265?v=4)](https://github.com/oyed "oyed (1 commits)")[![swilla](https://avatars.githubusercontent.com/u/304159?v=4)](https://github.com/swilla "swilla (1 commits)") --- Tags hipchathipchat-notificationslaravellaravel-notificationslaravel-packagenotificationslaravelnotificationschathipchat ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/laravel-notification-channels-hipchat/health.svg) ``` [![Health](https://phpackages.com/badges/laravel-notification-channels-hipchat/health.svg)](https://phpackages.com/packages/laravel-notification-channels-hipchat) ``` ### Alternatives [laravel-notification-channels/telegram Telegram Notifications Channel for Laravel 1.1k3.4M35](/packages/laravel-notification-channels-telegram)[laravel-notification-channels/discord Laravel notification driver for Discord. 2371.3M11](/packages/laravel-notification-channels-discord)[s-ichikawa/laravel-sendgrid-driver This library adds a 'sendgrid' mail driver to Laravel. 4139.3M1](/packages/s-ichikawa-laravel-sendgrid-driver)[laravel-notification-channels/twilio Provides Twilio notification channel for Laravel 2587.7M12](/packages/laravel-notification-channels-twilio)[benwilkins/laravel-fcm-notification Laravel FCM (Firebase Cloud Messaging) Notification Channel 210964.1k1](/packages/benwilkins-laravel-fcm-notification)[laravel-notification-channels/smsc-ru SmscRu Notifications channel for Laravel 5.3. 51192.8k](/packages/laravel-notification-channels-smsc-ru) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)