Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/symfony/slack-notifier
Symfony Slack Notifier Bridge
https://github.com/symfony/slack-notifier
component notifier php slack symfony symfony-component
Last synced: 4 days ago
JSON representation
Symfony Slack Notifier Bridge
- Host: GitHub
- URL: https://github.com/symfony/slack-notifier
- Owner: symfony
- License: mit
- Created: 2019-10-05T11:55:37.000Z (over 5 years ago)
- Default Branch: 7.2
- Last Pushed: 2024-11-29T09:07:01.000Z (2 months ago)
- Last Synced: 2025-01-15T04:33:27.070Z (18 days ago)
- Topics: component, notifier, php, slack, symfony, symfony-component
- Language: PHP
- Homepage: https://symfony.com/notifier
- Size: 201 KB
- Stars: 38
- Watchers: 6
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Slack Notifier
==============
Provides [Slack](https://slack.com) integration for Symfony Notifier.
DSN example
-----------
```
SLACK_DSN=slack://TOKEN@default?channel=CHANNEL
```
where:
- `TOKEN` is your Bot User OAuth Access Token (they begin with `xoxb-`)
- `CHANNEL` is a channel, private group, or IM channel to send message to, it can be an encoded ID, or a name.
valid DSN's are:
```
SLACK_DSN=slack://xoxb-......@default?channel=my-channel-name
SLACK_DSN=slack://xoxb-......@default?channel=@fabien
```
invalid DSN's are:
```
SLACK_DSN=slack://xoxb-......@default?channel=#my-channel-name
SLACK_DSN=slack://xoxb-......@default?channel=fabien
```
Adding Interactions to a Message
--------------------------------
With a Slack message, you can use the `SlackOptions` class to add some
interactive options called [Block elements](https://api.slack.com/reference/block-kit/block-elements).
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackActionsBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackDividerBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackImageBlockElement;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Contribute To Symfony');
// Create Slack Actions Block and add some buttons
$contributeToSymfonyBlocks = (new SlackActionsBlock())
->button(
'Improve Documentation',
'https://symfony.com/doc/current/contributing/documentation/standards.html',
'primary'
)
->button(
'Report bugs',
'https://symfony.com/doc/current/contributing/code/bugs.html',
'danger'
);
$slackOptions = (new SlackOptions())
->block((new SlackSectionBlock())
->text('The Symfony Community')
->accessory(
new SlackImageBlockElement(
'https://symfony.com/favicons/apple-touch-icon.png',
'Symfony'
)
)
)
->block(new SlackDividerBlock())
->block($contributeToSymfonyBlocks);
// Add the custom options to the chat message and send the message
$chatMessage->options($slackOptions);
$chatter->send($chatMessage);
```
Alternatively, a single button can be added to a section using the `accessory()` method and the `SlackButtonBlockElement` class.
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackButtonBlockElement;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackDividerBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Contribute To Symfony');
$slackOptions = (new SlackOptions())
->block((new SlackSectionBlock())
->text('Symfony Framework')
->accessory(
new SlackButtonBlockElement(
'Report bugs',
'https://symfony.com/doc/current/contributing/code/bugs.html',
'danger'
)
)
)
->block(new SlackDividerBlock())
->block((new SlackSectionBlock())
->text('Symfony Documentation')
->accessory(
new SlackButtonBlockElement(
'Improve Documentation',
'https://symfony.com/doc/current/contributing/documentation/standards.html',
'primary'
)
)
);
// Add the custom options to the chat message and send the message
$chatMessage->options($slackOptions);
$chatter->send($chatMessage);
```
Adding Fields and Values to a Message
-------------------------------------
To add fields and values to your message you can use the `field()` method.
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackDividerBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Symfony Feature');
$options = (new SlackOptions())
->block((new SlackSectionBlock())->text('My message'))
->block(new SlackDividerBlock())
->block(
(new SlackSectionBlock())
->field('*Max Rating*')
->field('5.0')
->field('*Min Rating*')
->field('1.0')
);
// Add the custom options to the chat message and send the message
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Define text objects properties
------------------------------
[Text objects properties](https://api.slack.com/reference/block-kit/composition-objects#text) can be set on any `text()` or `field()` method :
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Slack Notifier');
$options = (new SlackOptions())
->block(
(new SlackSectionBlock())
->field('My **Markdown** content with clickable URL : symfony.com') // Markdown content (default)
->field('*Plain text content*', markdown: false) // Plain text content
->field('Not clickable URL : symfony.com', verbatim: true) // Only for markdown content
->field('Thumbs up emoji code is :thumbsup: ', emoji: false) // Only for plain text content
);
// Add the custom options to the chat message and send the message
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Adding a Header to a Message
----------------------------
To add a header to your message use the `SlackHeaderBlock` class.
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackDividerBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackHeaderBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Symfony Feature');
$options = (new SlackOptions())
->block((new SlackHeaderBlock('My Header')))
->block((new SlackSectionBlock())->text('My message'))
->block(new SlackDividerBlock())
->block(
(new SlackSectionBlock())
->field('*Max Rating*')
->field('5.0')
->field('*Min Rating*')
->field('1.0')
);
// Add the custom options to the chat message and send the message
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Adding a Footer to a Message
----------------------------
To add a header to your message use the `SlackContextBlock` class.
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackContextBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackDividerBlock;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Symfony Feature');
$contextBlock = (new SlackContextBlock())
->text('My Context')
->image('https://symfony.com/logos/symfony_white_03.png', 'Symfony Logo')
;
$options = (new SlackOptions())
->block((new SlackSectionBlock())->text('My message'))
->block(new SlackDividerBlock())
->block(
(new SlackSectionBlock())
->field('*Max Rating*')
->field('5.0')
->field('*Min Rating*')
->field('1.0')
)
->block($contextBlock)
;
// Add the custom options to the chat message and send the message
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Sending a Message as a Reply
----------------------------
To send your Slack message as a reply in a thread use the `threadTs()` method.
```php
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackSectionBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$chatMessage = new ChatMessage('Symfony Feature');
$options = (new SlackOptions())
->block((new SlackSectionBlock())->text('My reply'))
->threadTs('1621592155.003100')
;
// Add the custom options to the chat message and send the message
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Updating a Slack Message
------------------------
First, save the message ID and channel ID when sending a message:
```php
use Symfony\Component\Notifier\Bridge\Slack\SlackSentMessage;
use Symfony\Component\Notifier\Message\ChatMessage;
$sentMessage = $chatter->send(new ChatMessage('Original message'));
// Make sure that Slack transport was used
if ($sentMessage instanceOf SlackSentMessage) {
$messageId = $sentMessage->getMessageId();
$channelId = $sentMessage->getChannelId();
}
```
Then, use that message ID and channel ID to create a new
``UpdateMessageSlackOptions`` class:
```php
use Symfony\Component\Notifier\Bridge\Slack\UpdateMessageSlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$options = new UpdateMessageSlackOptions($channelId, $messageId);
$chatter->send(new ChatMessage('Updated message', $options));
```
Scheduling a Slack Message
--------------------------
To schedule a message to be sent at a later time, use the `postAt()` method:
```php
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Message\ChatMessage;
$options = (new SlackOptions())->postAt(new \DateTime('+1 day'));
$chatMessage = new ChatMessage('Symfony Feature');
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Resources
---------
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
* [Report issues](https://github.com/symfony/symfony/issues) and
[send Pull Requests](https://github.com/symfony/symfony/pulls)
in the [main Symfony repository](https://github.com/symfony/symfony)