Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/interactive-slack-notification-channel
Send interactive Slack notifications in Laravel apps
https://github.com/spatie/interactive-slack-notification-channel
api interactive laravel notifications php
Last synced: 4 days ago
JSON representation
Send interactive Slack notifications in Laravel apps
- Host: GitHub
- URL: https://github.com/spatie/interactive-slack-notification-channel
- Owner: spatie
- License: mit
- Created: 2021-01-20T19:14:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T22:36:21.000Z (8 months ago)
- Last Synced: 2024-10-05T11:47:27.391Z (about 1 month ago)
- Topics: api, interactive, laravel, notifications, php
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 143 KB
- Stars: 61
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Send interactive Slack notifications in Laravel apps
[](https://packagist.org/packages/spatie/interactive-slack-notification-channel)
[](https://packagist.org/packages/spatie/interactive-slack-notification-channel)
This package allows you to send interactive Slack notifications. Here's how such a notification could look like
## Support us
[
](https://spatie.be/github-ad-click/interactive-slack-notification-channel)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can
support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards
on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/interactive-slack-notification-channel
```
## Usage
In your `Notifiable` classes you should add a method named `routeNotificationForInteractiveSlack` that returns an array with the
API token, an optionally the channel name
```php
public function routeNotificationForInteractiveSlack()
{
return [
'token' => 'xoxp-slack-token',
'channel' => '#general' // this is optional
];
}
```
### Replying to message threads
Let's assume you want your application to send a Slack notification when an order gets placed. You also want any
subsequent messages about the order be place in the same thread.
Using the SlackApi channels you can retrieve the API response from Slack's `chat.postMessage` method. With this response
you could post messages on other events that happen on the order, such as order paid, shipped, closed, etc.
Here's an example:
```php
use Spatie\InteractiveSlackNotificationChannel\Messages\SlackMessage
public function toInteractiveSlack($notifiable)
{
return (new SlackMessage)->content('A new order has been placed');
}
public function interactiveSlackResponse(array $response)
{
$this->order->update(['slack_thread_ts' => $response['ts']]);
}
```
In your order paid event you can have
```php
use Spatie\InteractiveSlackNotificationChannel\Messages\SlackMessage;
use Spatie\InteractiveSlackNotificationChannel\Messages\SlackAttachment;
public function toInteractiveSlack($notifiable)
{
$order = $this->order;
return (new SlackMessage)
->success()
->content('Order paid')
->threadTimestamp($order->slack_thread_ts)
->attachment(function(SlackAttachment $attachment) use ($order) {
$attachment
->title("Order $order->reference has been paid for.")
->content('Should now be processed.')
->action('View Order', route('orders', $order->reference));
});
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
Some parts of the code and readme are based on [this package](https://github.com/beyondcode/slack-notification-channel).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.