airondev / laravel-slack-alerts
Send a message to Slack
Requires
- php: ^7.3|^8.0
- illuminate/contracts: ^8.73|^9.0
- spatie/laravel-package-tools: ^1.9.2
Requires (Dev)
- nunomaduro/collision: ^5.10|^6.0
- nunomaduro/larastan: ^1.0|2.0
- orchestra/testbench: ^6.22
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is not auto-updated.
Last update: 2025-02-27 15:12:34 UTC
README
Quickly send a message to Slack
This package can quickly send alerts to Slack. You can use this to notify yourself of any noteworthy events happening in your app.
use Spatie\SlackAlerts\Facades\SlackAlert; SlackAlert::message("You have a new subscriber to the {$newsletter->name} newsletter!");
Under the hood, a job is used to communicate with Slack. This prevents your app from failing in case Slack is down.
Want to send alerts to Discord instead? Check out laravel-discord-alerts.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
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. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/laravel-slack-alerts
You can set a SLACK_ALERT_WEBHOOK
env variable containing a valid Slack webhook URL. You can learn how to get a webhook URL in the Slack API docs.
Alternatively, you can publish the config file with:
php artisan vendor:publish --tag="slack-alerts-config"
This is the contents of the published config file:
return [ /* * The webhook URLs that we'll use to send a message to Slack. */ 'webhook_urls' => [ 'default' => env('SLACK_ALERT_WEBHOOK'), ], /* * This job will send the message to Slack. You can extend this * job to set timeouts, retries, etc... */ 'job' => Spatie\SlackAlerts\Jobs\SendToSlackChannelJob::class, ];
Usage
To send a message to Slack, simply call SlackAlert::message()
and pass it any message you want.
SlackAlert::message("You have a new subscriber to the {$newsletter->name} newsletter!");
Using multiple webhooks
You can also use an alternative webhook, by specify extra ones in the config file.
// in config/slack-alerts.php 'webhook_urls' => [ 'default' => 'https://hooks.slack.com/services/XXXXXX', 'marketing' => 'https://hooks.slack.com/services/YYYYYY', ],
The webhook to be used can be chosen using the to
function.
use Spatie\SlackAlerts\Facades\SlackAlert; SlackAlert::to('marketing')->message("You have a new subscriber to the {$newsletter->name} newsletter!");
Using a custom webhooks
The to
function also supports custom webhook urls.
use Spatie\SlackAlerts\Facades\SlackAlert; SlackAlert::to('https://custom-url.com')->message("You have a new subscriber to the {$newsletter->name} newsletter!");
Formatting
Markdown
You can format your messages with Slack's markup. Learn how in the Slack API docs.
use Spatie\SlackAlerts\Facades\SlackAlert; SlackAlert::message("A message *with some bold statements* and _some italicized text_.");
Links are formatted differently in Slack than the classic markdown structure.
SlackAlert::message("<https://spatie.be|This is a link to our homepage>");
Emoji's
You can use the same emoji codes as in Slack. This means custom emoji's are also supported.
use Spatie\SlackAlerts\Facades\SlackAlert; SlackAlert::message(":smile: :custom-code:");
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
Alternatives
If you want to send rich messages with Block Kit, we suggest using slack-php/slack-php-block-kit