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

branch	status	minimum PHP version
master		PHP 7.0
1.x		PHP 5.6

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

• carpediem
• ThibaudDauce/mattermost-php
• All Contributors

License

The MIT License (MIT). Please see License File for more information.