{"id":20696000,"url":"https://github.com/laravel-notification-channels/gitter","last_synced_at":"2025-08-14T18:35:46.931Z","repository":{"id":57012028,"uuid":"65855374","full_name":"laravel-notification-channels/gitter","owner":"laravel-notification-channels","description":"Gitter.im notifications channel for Laravel","archived":false,"fork":false,"pushed_at":"2020-09-12T05:37:41.000Z","size":24,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T03:32:14.531Z","etag":null,"topics":["gitter-api","laravel","laravel-5-package","notification-channel","notifications"],"latest_commit_sha":null,"homepage":"http://laravel-notification-channels.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/laravel-notification-channels.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-16T21:37:14.000Z","updated_at":"2020-09-12T05:35:43.000Z","dependencies_parsed_at":"2022-08-21T13:40:51.639Z","dependency_job_id":null,"html_url":"https://github.com/laravel-notification-channels/gitter","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laravel-notification-channels%2Fgitter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laravel-notification-channels%2Fgitter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laravel-notification-channels%2Fgitter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laravel-notification-channels%2Fgitter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/laravel-notification-channels","download_url":"https://codeload.github.com/laravel-notification-channels/gitter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250320082,"owners_count":21411300,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitter-api","laravel","laravel-5-package","notification-channel","notifications"],"created_at":"2024-11-17T00:12:11.576Z","updated_at":"2025-04-22T20:41:36.629Z","avatar_url":"https://github.com/laravel-notification-channels.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gitter.im notifications channel for Laravel\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/gitter.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/gitter)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)\n[![Build Status](https://img.shields.io/travis/laravel-notification-channels/gitter/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/gitter)\n[![StyleCI](https://styleci.io/repos/65855374/shield)](https://styleci.io/repos/65855374)\n[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/f3b9fa9b-2315-4154-b8ad-f2d6661939dd.svg?style=flat-square)](https://insight.sensiolabs.com/projects/f3b9fa9b-2315-4154-b8ad-f2d6661939dd)\n[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/gitter.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/gitter)\n[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/gitter/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/gitter/?branch=master)\n[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/gitter.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/gitter)\n\nThis package makes it easy to send notifications using [Gitter.im](//gitter.im) with Laravel 5.5+, 6.x \u0026 7.x.\n\n## Contents\n\n- [Installation](#installation)\n\t- [Setting up the Gitter service](#setting-up-the-Gitter-service)\n- [Usage](#usage)\n\t- [Available Message methods](#available-message-methods)\n- [Changelog](#changelog)\n- [Testing](#testing)\n- [Security](#security)\n- [Contributing](#contributing)\n- [Credits](#credits)\n- [License](#license)\n\n\n## Installation\n\nInstall this package with Composer:\n\n```bash\ncomposer require laravel-notification-channels/gitter\n```\n\nIf you're using Laravel 5.x you'll also need to specify a version constraint:\n\n```bash\ncomposer require laravel-notification-channels/gitter -v 1.0.1\n```\n\n### Setting up the Gitter service\n\nIn order to send message to Gitter rooms, you need to obtain [Personal Access Token or application token](https://developer.gitter.im/apps).\n\n## Usage\n\nYou can use the channel in your `via()` method inside the notification:\n\n```php\nuse Illuminate\\Notifications\\Notification;\nuse NotificationChannels\\Gitter\\GitterMessage;\nuse NotificationChannels\\Gitter\\GitterChannel;\n\nclass TaskCompleted extends Notification\n{\n    public function via($notifiable)\n    {\n        return [GitterChannel::class];\n    }\n\n    public function toGitter($notifiable)\n    {\n        return GitterMessage::create(\"Task #{$notifiable-\u003eid} is complete!\")\n            -\u003eroom('room_id') // optional\n            -\u003efrom('user_or_app_access_token');\n    }\n}\n```\n\nIn order to let your notification know which Gitter room you are targeting, add the `routeNotificationForGitter` method to your Notifiable model:\n\n```php\npublic function routeNotificationForGitter()\n{\n    return 'room_id';\n}\n```\n\n### Available methods\n\n`from()`: Sets the sender's access token.\n\n`room()`: Specifies the room id to send the notification to (overridden by `routeNotificationForGitter` if empty).\n\n`content()`: Sets a content of the notification message. Supports Github flavoured markdown.\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.\n\n## Testing\n\n``` bash\n$ composer test\n```\n\n## Security\n\nIf you discover any security related issues, please email jhaoda@gmail.com instead of using the issue tracker.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## Credits\n\n- [JhaoDa](https://github.com/jhaoda)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaravel-notification-channels%2Fgitter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaravel-notification-channels%2Fgitter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaravel-notification-channels%2Fgitter/lists"}