Laravel Slack Notification Channel

For the SlackWebhookChannel to function, the object receiving the notification must define where the webhook should be sent. Implement the routeNotificationForSlack method (or routeNotificationFor with the 'slack' argument) on your notifiable model to return the webhook URL.

public function routeNotificationForSlack($notification)
{
    return 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX';
}

The SlackMessage class is used to construct the payload for Slack notifications. You can configure the destination channel, fallback text, username, and visual identity (icon/image). It also supports threading via threadTimestamp and controlling link/media unfurling.

use Illuminate\Notifications\Slack\SlackMessage;

SlackMessage::to('general')
    ->text('This is the fallback text')
    ->username('My Bot')
    ->emoji(':robot_face:')
    ->unfurlLinks()
    ->unfurlMedia();

The ActionsBlock class is used to define an interactive section in a Slack message using Block Kit. It acts as a container for interactive elements like buttons and select menus.

Key constraints:

• You must add at least one element to the block.
• There is a maximum of 25 elements allowed per ActionsBlock.
• The block_id (set via the id() method) must not exceed 255 characters.

Use the id() method to provide a unique identifier. This is useful when handling interaction payloads from Slack to identify which block triggered an action.

use Illuminate\Notifications\Slack\BlockKit\Blocks\ActionsBlock;

$block = (new ActionsBlock())
    ->id('my_unique_block_id')
    ->button('Click Me')
    ->staticSelect('Choose an option');

The SlackMessage class is used to construct messages using Slack's legacy attachment-based messaging format. It provides a fluent interface to set the message content, destination channel, sender identity, and visual styling based on the notification level.

Available Levels and Colors

The visual color of the message attachment is automatically determined by the level set via these methods:

• success(): Sets level to success (color: good)
• error(): Sets level to error (color: danger)
• warning(): Sets level to warning (color: warning)
• info(): Sets level to info (no specific color mapping)

use Illuminate\Notifications\Messages\SlackMessage;

SlackMessage::create()\n    ->content('Hello World!')\n    ->success()\n    ->to('#general');

The SlackWebhookChannel is used to send notifications to Slack using incoming webhooks.

To use this channel, your notifiable entity (e.g., a User or Team model) must implement a routeNotificationFor method that returns the Slack webhook URL when requested for the 'slack' channel.

When a notification is sent, the channel calls the toSlack method on your notification class. This method should return either a Illuminate\Notifications\Slack\SlackMessage or a legacy Illuminate\Notifications\Messages\SlackMessage object.

public function toSlack($notifiable)
{
    return (new SlackMessage)
        ->content('Hello, Slack!');
}

You can control the color scheme of the confirmation button using the style property.

• Use the danger() method to set the style to danger. This displays the button with a red background on desktop or red text on mobile.
• If no style is specified, it defaults to primary, which displays a green background on desktop or blue text on mobile.

$confirmObject = (new ConfirmObject())->danger();

The field() method allows you to add structured data to an attachment. It supports two ways of defining fields:

1. Simple Key-Value Pair: Pass a string title and a string content. The title acts as the key. $attachment->field('Key', 'Value');

2. Closure for Complex Fields: Pass a Closure as the first argument. The closure receives a SlackAttachmentField instance, allowing for more granular control (e.g., setting markdown content). $attachment->field(function (SlackAttachmentField $field) { $field->title('Key')->content('Value'); });

// Simple key-value
$attachment->field('Status', 'Completed');

// Using a closure for advanced configuration
$attachment->field(function ($field) {
    $field->title('Details');
    $field->content('This is a complex field');
});

You can attach an optional confirmation dialog to a button using the confirm method. This prevents accidental clicks by prompting the user before the action is executed.

When calling confirm, you must provide the confirmation text. You can optionally provide a callback to configure the ConfirmObject.

$button = new ButtonElement('Delete Record');

$button->confirm('Are you sure you want to delete this?', function ($confirm) {
    // Configure the confirm object if needed
});

Use these methods to control how Slack handles links and mentions within your message:

• linkNames(): Enables automatic linking of channel names and usernames.
• unfurlLinks($unfurlLinks): A boolean flag to determine if Slack should provide a preview of links in the message.
• unfurlMedia($unfurlMedia): A boolean flag to determine if Slack should provide a preview of media links.

SlackMessage::create()
    ->content('Check out #general and https://example.com')
    ->linkNames()
    ->unfurlLinks(true)
    ->unfurlMedia(true);