bt/rocketchat-php

A PHP interface to send incoming webhooks.

1.1 2016-04-29 07:31 UTC

Requires

• guzzlehttp/guzzle: ^6.2

MIT

• Bertram Truong

README

This library allows you to easily create Incoming Webhooks in for Rocket.Chat in PHP.

Installing

The recommended way to install rocketchat-php is through Composer.

composer require bt/rocketchat-php

You can then use rocketchat-php with Composer's auto-loader.

require 'vendor/autoload.php'

Text Example

A getting started code snippet. This will post a message to the webhook:

$client = new \RocketChatPhp\Client('https://demo.rocket.chat', 'webhook_token');
$client->payload([
    'text' => 'This will be sent to the webhook!'
]);

Attachments

You can also add attachments to the message like follows:

// Use this to toggle short or long text attachments.
$isShort = true;

$attachment = new \RocketChatPhp\Attachment('The text to be displayed if the client cannot load the attachment.', '#ffffff');
$attachment->addField('Field Title', 'Field Value', $isShort);
$attachment->addField('Field Title2', 'Field Value2', $isShort);

$client = new \RocketChatPhp\Client('https://demo.rocket.chat', 'webhook_token');
$client->payload([
    'text' => 'This is a test message with attachments!',
    'attachments' => [
    	$attachment->toArray()
    ]
]);