symfony / rocket-chat-notifier
Symfony RocketChat Notifier Bridge
Fund package maintenance!
fabpot
Tidelift
symfony.com/sponsor
Installs: 52 160
Dependents: 2
Suggesters: 0
Security: 0
Stars: 12
Watchers: 5
Forks: 3
Type:symfony-notifier-bridge
Requires
- php: >=8.2
- symfony/http-client: ^6.4|^7.0
- symfony/notifier: ^7.2
- 7.3.x-dev
- 7.2.x-dev
- v7.2.0
- v7.2.0-RC1
- v7.2.0-BETA1
- 7.1.x-dev
- v7.1.6
- v7.1.1
- v7.1.0
- v7.1.0-RC1
- v7.1.0-BETA1
- 7.0.x-dev
- v7.0.8
- v7.0.7
- v7.0.3
- v7.0.0
- v7.0.0-RC1
- v7.0.0-BETA1
- 6.4.x-dev
- v6.4.13
- v6.4.8
- v6.4.7
- v6.4.3
- v6.4.0
- v6.4.0-RC1
- v6.4.0-BETA1
- 6.3.x-dev
- v6.3.12
- v6.3.0
- v6.3.0-RC1
- v6.3.0-BETA1
- 6.2.x-dev
- v6.2.7
- v6.2.5
- v6.2.0
- v6.2.0-RC1
- v6.2.0-BETA1
- 6.1.x-dev
- v6.1.11
- v6.1.0
- v6.1.0-RC1
- v6.1.0-BETA1
- 6.0.x-dev
- v6.0.19
- v6.0.3
- v6.0.0
- v6.0.0-RC1
- v6.0.0-BETA2
- v6.0.0-BETA1
- 5.4.x-dev
- v5.4.45
- v5.4.40
- v5.4.39
- v5.4.35
- v5.4.21
- v5.4.19
- v5.4.3
- v5.4.0
- v5.4.0-RC1
- v5.4.0-BETA2
- v5.4.0-BETA1
- 5.3.x-dev
- v5.3.14
- v5.3.10
- v5.3.4
- v5.3.0
- v5.3.0-RC1
- v5.3.0-BETA1
- 5.2.x-dev
- v5.2.12
- v5.2.10
- v5.2.7
- v5.2.4
- v5.2.3
- v5.2.2
- v5.2.1
- v5.2.0
- v5.2.0-RC2
- v5.2.0-RC1
- v5.2.0-BETA3
- v5.2.0-BETA2
- v5.2.0-BETA1
- 5.1.x-dev
- v5.1.11
- v5.1.10
- v5.1.9
- v5.1.8
- v5.1.7
- v5.1.6
- v5.1.5
- v5.1.4
- v5.1.3
- v5.1.2
- v5.1.1
- v5.1.0
- v5.1.0-RC2
- v5.1.0-RC1
- v5.1.0-BETA1
This package is auto-updated.
Last update: 2024-11-30 02:08:21 UTC
README
Provides RocketChat integration for Symfony Notifier.
DSN example
ROCKETCHAT_DSN=rocketchat://ACCESS_TOKEN@default?channel=CHANNEL
where:
ACCESS_TOKEN
is your RocketChat webhook tokenCHANNEL
is your RocketChat channel, it may be overridden in the payload
Example (be sure to escape the middle slash with %2F):
# Webhook URL: https://rocketchathost/hooks/a847c392165c41f7bc5bbf273dd701f3/9343289d1c33464bb15ef132b5a7628d
ROCKETCHAT_DSN=rocketchat://a847c392165c41f7bc5bbf273dd701f3%2F9343289d1c33464bb15ef132b5a7628d@rocketchathost?channel=channel
Attachments and Payload
When creating a ChatMessage
, you can add payload and multiple attachments to
RocketChatOptions
. These enable you to customize the name or the avatar of the
bot posting the message, and to add files to it.
The payload can contain any data you want; its data is processed by a Rocket.Chat Incoming Webhook Script which you can write to best suit your needs. For example, you can use this script to send the raw payload to Rocket.Chat:
class Script { process_incoming_request({ request }) { return { request.content }; } }
When using this script, the Payload must be indexed following Rocket.Chat Payload convention:
$payload = [ 'alias' => 'Bot Name', 'emoji' => ':joy:', // Emoji used as avatar 'avatar' => 'http://site.com/logo.png', // Overridden by emoji if provided 'channel' => '#myChannel', // Overrides the DSN's channel setting ]; $attachement1 = [ 'color' => '#ff0000', 'title' => 'My title', 'text' => 'My text', // ... ]; $attachement2 = [ 'color' => '#ff0000', 'title' => 'My title', 'text' => 'My text', // ... ]; // For backward compatibility reasons, both usages are valid $rocketChatOptions = new RocketChatOptions($attachement1, $payload); $rocketChatOptions = new RocketChatOptions([$attachement1, $attachement2], $payload);
Note: the text
and attachments
keys of the payload will be overridden
respectively by the ChatMessage's subject and the attachments provided in
RocketChatOptions' constructor.