carpediem / mattermost-webhook
Sends mattermost webhook notifications using PHP
Installs: 24 635
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 3
Forks: 0
Open Issues: 1
Requires
- php: >=7.0
- guzzlehttp/guzzle: ^6.2
- psr/http-message-implementation: ^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.0
- phpunit/phpunit: ^6.2
README
This driver for Mattermost allows you to send message for incoming webhooks.
This is a fork from ThibaudDauce/mattermost-php
System Requirements
You need PHP >= 5.6.0 but the latest stable version of PHP is recommended.
Installation
$ composer require carpediem/mattermost-webhook
Build status
Basic usage
The code below will send a notification to a mattermost compliant service.
<?php require '/path/to/vendor/autoload.php'; use GuzzleHttp\Client as GuzzleClient; use Carpediem\Mattermost\Webhook\Client; use Carpediem\Mattermost\Webhook\Message; $mattermost = new Client(new GuzzleClient()); $message = new Message('This is a *test*.'); $response = $mattermost->notify('https://your_mattermost_webhook_url', $message); //$response is a Psr7\Http\Message\ResponseInterface.
Documentation
Full documentation can be found at carpediem.github.io.
Contributing
Contributions are welcome and will be fully credited. Please see CONTRIBUTINGfor details.
Testing
Mattermost Webhook
has a PHPUnit test suite and a coding style compliance test suite using PHP CS Fixer. To run the tests, run the following command from the project folder.
$ composer test
Security
If you discover any security related issues, please email dev@carpediem.fr instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.