Laravel Slack Notification Channel

https://github.com/laravel/slack-notification-channel
Admin
A Laravel package that provides a convenient way to send notifications to Slack, integrating Slack's...
Tokens:57,197
Snippets:380
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### SelectOption Usage Example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

Example of creating a SelectOption and converting it to an array, showing the sanitized value output.

```php
use Illuminate\Notifications\Slack\BlockKit\Elements\Selects\SelectOption;

$option = new SelectOption('Release v1.0', 'Release v1.0!');
$option->toArray();
// ['text' => ['type' => 'plain_text', 'text' => 'Release v1.0'], 'value' => 'releasev1.0']
```

--------------------------------

### StaticSelectElement Usage Example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

Example of configuring a static select menu within a Slack message and handling an invalid initial option.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Filter deployments')
    ->actionsBlock(function ($block) {
        $block->staticSelect('Filter by environment')
            ->id('env_filter')
            ->placeholder('Select environment')
            ->focus()
            ->addOption('Production', 'production')
            ->addOption('Staging', 'staging')
            ->initialOption('production');
    });

// Unknown option value:
try {
    $select = (new \Illuminate\Notifications\Slack\BlockKit\Elements\Selects\StaticSelectElement)
        ->addOption('Production', 'production');
    $select->initialOption('nope');
} catch (\InvalidArgumentException $e) {
    // 'Unknown option value: nope.'
}
```

--------------------------------

### Examples

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackMessage.md

Usage examples for constructing Slack messages with Block Kit blocks, including basic messages, conditional blocks, threaded replies, and raw templates.

```APIDOC
## Examples

### Basic Block Kit message

```php
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Slack\SlackMessage;

class OrderShipped extends Notification
{
    public function via($notifiable)
    {
        return ['slack'];
    }

    public function toSlack($notifiable)
    {
        return (new SlackMessage)
            ->to('#orders')
            ->text('Order shipped!')
            ->headerBlock('Order #1234 shipped')
            ->sectionBlock(function ($block) {
                $block->text('Your order is on the way.')->markdown();
            })
            ->dividerBlock()
            ->imageBlock('https://example.com/tracking-map.png', 'Tracking map');
    }
}
```

### Using the `Conditionable` trait, threaded replies and raw templates

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Report ready')
    ->threadTimestamp('1700000000.000100')
    ->broadcastReply()
    ->when($sendDailyDigest, fn (SlackMessage $m) => $m->sectionBlock(
        fn ($block) => $block->field('Orders', '42')->field('Revenue', '$9,400')
    ));

// Raw Block Kit Builder JSON (copied from https://app.slack.com/block-kit-builder):
$message->usingBlockKitTemplate('{"blocks":[{"type":"section","text":{"type":"mrkdwn","text":"Hello"}}]}');

// Validation/error handling happens at serialization time:
try {
    $payload = $message->toArray();
} catch (\LogicException $e) {
    // "Slack messages must contain at least a text message or block." (empty message)
    // "Slack messages can only contain up to 50 blocks." (>50 blocks)
} catch (\JsonException $e) {
    // Malformed JSON passed to usingBlockKitTemplate().
}
```
```

--------------------------------

### Usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/EventMetadata.md

Demonstrates creating metadata directly or via the SlackMessage builder.

```php
use Illuminate
otifications\
Slack\
EventMetadata;
use Illuminate
otifications\
Slack\
SlackMessage;

// Either directly:
$metadata = EventMetadata::make('order_shipped', ['order_id' => 1234]);
$metadata->toArray();
// ['event_type' => 'order_shipped', 'event_payload' => ['order_id' => 1234]]

// Or via the message builder (constructs an EventMetadata internally):
$message = (new SlackMessage)
    ->text('Order shipped!')
    ->metadata('order_shipped', ['order_id' => 1234]);

// SlackMessage::toArray() includes the 'metadata' key enclosing the same shape:
// 'metadata' => ['event_type' => 'order_shipped', 'event_payload' => ['order_id' => 1234]]
```

--------------------------------

### ImageElement usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Elements.md

Example of creating a Slack message with an image element in a context block, and handling the LogicException when alt text is missing.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Build status')
    ->contextBlock(function ($block) {
        $block->image('https://example.com/build-status.png', 'Build passing');
        $block->text('Build #420 passed');
    });

// If alt text is never set:
try {
    (new \Illuminate\Notifications\Slack\BlockKit\Elements\ImageElement('https://example.com/x.png'))->toArray();
} catch (\LogicException $e) {
    // 'Alt text is required for an image element.'
}
```

--------------------------------

### ButtonElement usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Elements.md

Example of creating a Slack message with two buttons: one with URL, value, and accessibility label; another with custom ID, primary style, and confirmation dialog. Also shows that validation errors throw immediately, not at serialization.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Choose an action')
    ->actionsBlock(function ($block) {
        $block->button('View on GitHub')
            ->url('https://github.com/laravel/framework')
            ->value('open_repo')
            ->accessibilityLabel('Opens the repository page');

        $block->button('Deploy')
            ->id('deploy_button')
            ->primary()
            ->confirm('Deploy to production?', function ($confirm) {
                $confirm->confirm('Deploy now')->danger();
            });
    });

// Validation errors throw immediately (not at serialization):
try {
    (new \Illuminate\Notifications\Slack\BlockKit\Elements\ButtonElement('Go'))
        ->url(str_repeat('x', 3001));
} catch (\InvalidArgumentException $e) {
    // 'Maximum length for the url field is 3000 characters.'
}
```

--------------------------------

### Example usage with SlackMessage

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachmentField.md

Example of creating a Slack message with attachment fields, including a short field and a long field.

```php
use Illuminate\Notifications\Messages\SlackMessage;

$message = (new SlackMessage)->content('Server report')
    ->attachment(function ($attachment) {
        $attachment->field(function ($field) {
            $field->title('Region')->content('us-east-1');        // short: true (default)
        });
        $attachment->field(function ($field) {
            $field->title('Full stack trace')->content($trace)->long(); // short: false
        });
    });
```

--------------------------------

### Basic attachment example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachment.md

Shows how to build a Slack message with an attachment using the SDK, including title, pretext, content, color, author, fields, markdown, image, thumb, footer, and callback ID.

```APIDOC
## Basic attachment example

### Description
Builds a Slack message attachment with all available methods.

### Example
```php
use Illuminate\Notifications\Messages\SlackMessage;

$message = (new SlackMessage)->content('Incident report')
    ->attachment(function ($attachment) {
        $attachment->title('Incident #42', 'https://status.example.com/incidents/42')
            ->pretext('New incident opened')
            ->content('API latency is elevated.')
            ->fallback('Incident #42: API latency elevated')
            ->color('#ff0000')
            ->author('Monitoring', 'https://status.example.com', 'https://status.example.com/ghost.png')
            ->field('Severity', 'High')
            ->field(function ($field) {
                $field->title('Owner')->content('Platform team')->long();
            })
            ->markdown(['pretext', 'text'])
            ->image('https://status.example.com/incidents/42.png')
            ->thumb('https://status.example.com/incidents/42-thumb.png')
            ->footer('Generated automatically')
            ->footerIcon('https://status.example.com/icon.png')
            ->timestamp(now())
            ->callbackId('incident_42');
    });
```
```

--------------------------------

### ImageBlock usage example with overloads and error handling

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-ImageBlock.md

Shows creating an image block with a closure, an overload variant omitting alt text, and a try-catch for the mandatory alt text requirement.

```php
use Illuminate\Notifications\Slack\SlackMessage;
use Illuminate\Notifications\Slack\BlockKit\Blocks\ImageBlock;

$message = (new SlackMessage)
    ->text('Deployment chart')
    ->imageBlock('https://example.com/charts/deploy-42.png', 'Deployment success rate', function (ImageBlock $image) {
        $image->id('chart_image')
            ->title('Deploy rate')->emoji();
    });

// Overload variant — closure as second argument (alt text omitted):
$message = (new SlackMessage)
    ->text('Chart')
    ->imageBlock('https://example.com/chart.png', function (ImageBlock $image) {
        $image->alt('Chart');
    });

// Alt text is mandatory — serialization throws if missing:
try {
    (new ImageBlock('https://example.com/image.png'))->toArray();
} catch (\LogicException $e) {
    // 'Alt text is required for an image block.'
}
```

--------------------------------

### Field styles example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachment.md

Demonstrates two ways to add fields to an attachment: a simple key-value pair and a SlackAttachmentField instance with chaining.

```APIDOC
## Field styles example

### Description
Shows both plain field and SlackAttachmentField instance usage.

### Example
```php
$message = (new SlackMessage)->content('Metrics')
    ->attachment(function ($attachment) {
        // Plain key/value field → serialized with short: true:
        $attachment->field('Region', 'eu-west-1');

        // SlackAttachmentField instance → toArray() honors long()/short:
        $attachment->field(function ($field) {
            $field->title('Full log')->content($longText)->long();
        });
    });
```
```

--------------------------------

### UsersSelectElement Usage Example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

Example of adding a users select element to a Slack message within an actions block.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Assign the incident')
    ->actionsBlock(function ($block) {
        $block->usersSelect('Assign to…')
            ->id('assignee')
            ->placeholder('Choose a user')
            ->initialUser('U12345678');
    });
```

--------------------------------

### SectionBlock usage example with accessory and error handling

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-SectionBlock.md

Example of building a section block with text, fields, and a static select accessory. Also shows that calling toArray() on a SectionBlock without text or fields throws a LogicException with the message 'A section requires at least one block, or the text to be set.'

```php
use Illuminate\Notifications\Slack\BlockKit\Elements\Selects\StaticSelectElement;
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Order summary')
    ->sectionBlock(function ($block) {
        $block->id('order_summary')
            ->text('Please review your order.')->markdown()
            ->field('Subtotal')->markdown()->verbatim()
            ->field('Tax')
            ->field('Total');

        // Attach a select as accessory:
        $block->accessory((new StaticSelectElement)
            ->placeholder('Change status')
            ->addOption('Shipped', 'shipped')
            ->addOption('Cancelled', 'cancelled'));
    });

// Missing text/fields throws at serialization:
try {
    (new \Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock)->toArray();
} catch (\LogicException $e) {
    // 'A section requires at least one block, or the text to be set.'
}
```

--------------------------------

### ImageElement

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Elements.md

Documentation for the ImageElement class, including its constructor, methods, and usage example.

```APIDOC
## ImageElement

### Description
Creates an image element for a Slack Block Kit context block. The element requires a URL and alt text at serialization time.

### Constructor

```php
public function __construct(string $url, ?string $altText = null)
```

**Parameters:**

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$url` | `string` | yes | — | Image URL |
| `$altText` | `?string` | no | `null` | Plain-text alt text; required at serialization |

### Methods

#### `alt(string $altText): self`

Sets the alt text for the image element.

**Parameters:**

- `$altText` (string) - Required - The alt text to set.

**Returns:** `self` - The current instance for chaining.

#### `toArray(): array`

Serializes the element to an array. Throws `LogicException` if alt text is not set.

**Returns:** `array` - The serialized element array with `type`, `image_url`, and `alt_text` keys.

**Throws:** `LogicException` - If `altText` is `null`.

### Example

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Build status')
    ->contextBlock(function ($block) {
        $block->image('https://example.com/build-status.png', 'Build passing');
        $block->text('Build #420 passed');
    });

// If alt text is never set:
try {
    (new \Illuminate\Notifications\Slack\BlockKit\Elements\ImageElement('https://example.com/x.png'))->toArray();
} catch (\LogicException $e) {
    // 'Alt text is required for an image element.'
}
```
```

--------------------------------

### Basic Slack attachment example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachment.md

Shows how to build a Slack message attachment with title, pretext, content, fallback, color, author, fields, markdown, image, thumb, footer, timestamp, and callback ID. Uses the SlackMessage class and a closure for the attachment.

```php
use Illuminate\Notifications\Messages\SlackMessage;

$message = (new SlackMessage)->content('Incident report')
    ->attachment(function ($attachment) {
        $attachment->title('Incident #42', 'https://status.example.com/incidents/42')
            ->pretext('New incident opened')
            ->content('API latency is elevated.')
            ->fallback('Incident #42: API latency elevated')
            ->color('#ff0000')
            ->author('Monitoring', 'https://status.example.com', 'https://status.example.com/ghost.png')
            ->field('Severity', 'High')
            ->field(function ($field) {
                $field->title('Owner')->content('Platform team')->long();
            })
            ->markdown(['pretext', 'text'])
            ->image('https://status.example.com/incidents/42.png')
            ->thumb('https://status.example.com/incidents/42-thumb.png')
            ->footer('Generated automatically')
            ->footerIcon('https://status.example.com/icon.png')
            ->timestamp(now())
            ->callbackId('incident_42');
    });
```

--------------------------------

### PlainTextOnlyTextObject usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Composites.md

Example of creating a PlainTextOnlyTextObject, setting emoji, and converting to array. Also shows truncation for overlong text and catching minimum length violation.

```php
use Illuminate\Notifications\Slack\BlockKit\Composites\PlainTextOnlyTextObject;

$text = new PlainTextOnlyTextObject('Hello');
$text->emoji();
$text->toArray();
// ['type' => 'plain_text', 'text' => 'Hello', 'emoji' => true]

// Truncation instead of error for overlong text:
$long = new PlainTextOnlyTextObject(str_repeat('x', 3000), 3000); // truncated to 2997 chars + '...'

// Minimum length violation:
try {
    new PlainTextOnlyTextObject('', 3000, 1);
} catch (\InvalidArgumentException $e) {
    // 'Text must be at least 1 character(s) long.'
}
```

--------------------------------

### Conditionable trait, threaded replies, and raw templates example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackMessage.md

Demonstrates using the Conditionable trait with when(), setting a thread timestamp, broadcasting a reply, and using a raw Block Kit template with error handling for validation and JSON exceptions.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Report ready')
    ->threadTimestamp('1700000000.000100')
    ->broadcastReply()
    ->when($sendDailyDigest, fn (SlackMessage $m) => $m->sectionBlock(
        fn ($block) => $block->field('Orders', '42')->field('Revenue', '$9,400')
    ));

// Raw Block Kit Builder JSON (copied from https://app.slack.com/block-kit-builder):
$message->usingBlockKitTemplate('{"blocks":[{"type":"section","text":{"type":"mrkdwn","text":"Hello"}}]}');

// Validation/error handling happens at serialization time:
try {
    $payload = $message->toArray();
} catch (\LogicException $e) {
    // "Slack messages must contain at least a text message or block." (empty message)
    // "Slack messages can only contain up to 50 blocks." (>50 blocks)
} catch (\JsonException $e) {
    // Malformed JSON passed to usingBlockKitTemplate().
}
```

--------------------------------

### Basic Block Kit message example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackMessage.md

Shows a notification class using SlackMessage to send a message with header, section, divider, and image blocks to a Slack channel.

```php
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Slack\SlackMessage;

class OrderShipped extends Notification
{
    public function via($notifiable)
    {
        return ['slack'];
    }

    public function toSlack($notifiable)
    {
        return (new SlackMessage)
            ->to('#orders')
            ->text('Order shipped!')
            ->headerBlock('Order #1234 shipped')
            ->sectionBlock(function ($block) {
                $block->text('Your order is on the way.')->markdown();
            })
            ->dividerBlock()
            ->imageBlock('https://example.com/tracking-map.png', 'Tracking map');
    }
}
```

--------------------------------

### TextObject usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Composites.md

Creates a TextObject with mrkdwn text, enables markdown and verbatim, then serializes. The output array includes 'type', 'text', and 'verbatim'.

```php
use Illuminate\Notifications\Slack\BlockKit\Composites\TextObject;

$text = new TextObject('*Deploy finished* at <https://example.com|the site>');
$text->markdown()->verbatim();
$text->toArray();
// ['type' => 'mrkdwn', 'text' => '…', 'verbatim' => true]
```

--------------------------------

### ContextBlock usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Example of adding a context block to a Slack message. The closure receives a ContextBlock instance; chain id(), image(), and text() methods to populate the block.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Deploy finished')
    ->contextBlock(function ($block) {
        $block->id('deploy_context')
            ->image('https://example.com/deploy-status.png', 'Deploy status')
            ->text('Deployed by <@U1234>')
            ->text('2024-01-15 10:00 UTC');
    });
```

--------------------------------

### DividerBlock usage example

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Example of adding a divider block to a Slack message. The dividerBlock() method adds a divider with no additional configuration.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Report')
    ->dividerBlock()
    ->sectionBlock(fn ($block) => $block->text('Summary follows.'));
```

--------------------------------

### Basic usage - routing to Web API by channel name

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackNotificationRouterChannel.md

Example notification class that sends a Slack message to a channel name, which routes to the Web API transport.

```php
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Slack\SlackMessage;

class DeploymentCompleted extends Notification
{
    public function via($notifiable)
    {
        return ['slack'];
    }

    public function toSlack($notifiable)
    {
        return (new SlackMessage)
            ->to('#deployments')
            ->text('Deployment finished.');
    }
}

// routeNotificationFor('slack') returns a channel name →
// SlackNotificationRouterChannel dispatches to Slack\SlackChannel
$user->notify(new DeploymentCompleted($deployment));
```

--------------------------------

### Create SlackMessage with headerBlock

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Example of creating a Slack message with a header block. The callback receives the PlainTextOnlyTextObject, and calling emoji() escapes emojis into colon format.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Daily digest')
    ->headerBlock('Tuesday report', function ($text) {
        $text->emoji(); // escape emojis into colon format
    });
```

--------------------------------

### Constructor

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/EventMetadata.md

Initializes a new event metadata instance with a type and an optional payload.

```php
/**
 * Create a new event metadata instance.
 *
 * @param  string  $type
 * @param  array  $payload
 * @return void
 */
public function __construct(string $type, array $payload = [])
```

--------------------------------

### make() static factory for SlackRoute

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackRoute.md

Fluently creates a new Slack route instance. Equivalent to new SlackRoute($channel, $token).

```php
/**
 * Fluently create a new Slack route instance.
 */
public static function make(?string $channel = null, ?string $token = null): self
{
    return new self($channel, $token);
}
```

--------------------------------

### Constructor for SlackChannel

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackChannel.md

Creates a new Slack channel instance with an injected HTTP client factory.

```php
/**
 * Create a new Slack channel instance.
 *
 * @param  \Illuminate\Http\Client\Factory  $http
 * @return void
 */
public function __construct(Factory $http)
```

--------------------------------

### Resulting array for first field

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachmentField.md

The exact array produced by toArray() for the first field in the example above.

```php
['title' => 'Region', 'value' => 'us-east-1', 'short' => true]
```

--------------------------------

### Basic usage of SlackRoute in a notifiable class

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackRoute.md

Shows how to use SlackRoute::make() in a notifiable class to specify channel and token per-notification. Includes commented alternatives for channel-only and shorthand string routes.

```php
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Slack\SlackRoute;

class Deployment
{
    use Notifiable;

    public function routeNotificationForSlack()
    {
        // Channel + token fully specified for this notifiable:
        return SlackRoute::make('deployments', 'xoxb-1234567890-abcdefghij');

        // Channel only — token falls back to services.slack.notifications.bot_user_oauth_token:
        // return SlackRoute::make('deployments');
        // or shorthand:
        // return 'deployments';
    }
}
```

--------------------------------

### Verifying the channel is registered

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackChannelServiceProvider.md

Shows how to use the Notification facade to send a notification through the 'slack' channel after the provider is auto-discovered.

```php
use Illuminate\Support\Facades\Notification;

// The provider is auto-discovered; nothing to instantiate in application code.
// After boot, the manager knows the 'slack' channel:

$manager = Notification::getFacadeRoot(); // Illuminate\Notifications\ChannelManager

// Sending through the channel works end-to-end:
Notification::route('slack', 'https://hooks.slack.com/services/...')
    ->notify(new OrderShipped($order));
```

--------------------------------

### Routing to webhook transport and dropping notifications

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackNotificationRouterChannel.md

Example User model with routeNotificationForSlack returning a webhook URL to use the legacy Guzzle transport, or false to skip the notification.

```php
use Illuminate\Notifications\Notifiable;

class User
{
    use Notifiable;

    public function routeNotificationForSlack()
    {
        // Return a webhook URL to use the legacy Guzzle transport...
        return 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX';

        // Return false to skip this notification entirely:
        // return false;
    }
}
```

--------------------------------

### make() static factory

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/EventMetadata.md

A fluent static factory method for creating an EventMetadata instance.

```php
/**
 * Fluently create a new event metadata instance.
 */
public static function make(string $type, array $payload = []): self
{
    return new self($type, $payload);
}
```

--------------------------------

### Constructor for SlackRoute

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackRoute.md

Creates a new Slack route instance with optional channel and token parameters.

```php
/**
 * Create a new Slack route instance.
 */
public function __construct(?string $channel = null, ?string $token = null)
```

--------------------------------

### register() method signature

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackChannelServiceProvider.md

Defines the register() method with a docblock and void return type.

```php
/**
 * Register the service provider.
 *
 * @return void
 */
public function register()
```

--------------------------------

### Error handling context for SlackRoute

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackRoute.md

Shows how to catch LogicException when SlackRoute values are unusable, with comments indicating the exact exception messages.

```php
try {
    $deployment->notify(new DeploymentFinished());
} catch (\LogicException $e) {
    // 'Slack notification channel is not set.'       — no channel anywhere
    // 'Slack API authentication token is not set.'   — no token anywhere
}
```

--------------------------------

### ConfirmObject usage in Slack message and standalone

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Composites.md

Shows how to use ConfirmObject within a Slack message's actions block and standalone. The standalone example creates a ConfirmObject with 'Continue?' and then calls toArray(). Note that the style key is omitted when null and defaults to 'danger' after danger() is called.

```php
use Illuminate\Notifications\Slack\BlockKit\Composites\ConfirmObject;
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Delete the database?')
    ->actionsBlock(function ($block) {
        $block->button('Delete')
            ->danger()
            ->confirm('This cannot be undone.', function ($confirm) {
                $confirm->title('Delete database?')
                    ->confirm('Yes, delete')
                    ->deny('Cancel')
                    ->danger();
            });
    });
```

```php
// Standalone use:
$confirm = new ConfirmObject('Continue?'); // title 'Are you sure?', confirm 'Yes', deny 'No'
$confirm->toArray();
// ['title' => [...], 'text' => [...], 'confirm' => [...], 'deny' => [...], 'style' => 'danger' after danger()]
```

--------------------------------

### Constructor for SlackWebhookChannel

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackWebhookChannel.md

Constructor that accepts a GuzzleHttp\Client instance for posting payloads to the webhook.

```php
/**
 * Create a new Slack channel instance.
 *
 * @return void
 */
public function __construct(HttpClient $http)
```

--------------------------------

### Constructor: __construct(HttpClient $http)

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackWebhookChannel.md

Creates a new SlackWebhookChannel instance with the Guzzle HTTP client used to POST the payload to the webhook URL.

```APIDOC
## Constructor: __construct(HttpClient $http)

### Description
Creates a new Slack channel instance. The Guzzle HTTP client is used to POST the payload to the webhook URL.

### Method
Constructor

### Constructor Parameters
- `$http` (GuzzleHttp\Client) - Required - The Guzzle HTTP client used to POST the payload to the webhook.

### Return Value
void
```

--------------------------------

### action() method implementation

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachment.md

Shows the implementation of action(). It appends an array with 'type' => 'button', 'text' => $title, 'url' => $url, and 'style' => $style to the $actions property.

```php
$this->actions[] = [
    'type' => 'button',
    'text' => $title,
    'url' => $url,
    'style' => $style,
];
```

--------------------------------

### ContextBlock

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Documentation for the ContextBlock class, which is added via SlackMessage::contextBlock().

```APIDOC
## ContextBlock

### Description
Adds a context block to a Slack message. Context blocks can contain image elements and text objects, with a maximum of 10 items and at least 1 required.

### Method
`SlackMessage::contextBlock(Closure $callback)`

### Parameters
- `$callback` (Closure) - Required - A closure that receives a `ContextBlock` instance to configure the block.

### Methods

#### `id(string $id): self`
Sets the block ID.

#### `image(string $imageUrl, ?string $altText = null): ImageElement`
Adds an image element to the context block.

#### `text(string $text): TextObject`
Adds a text object to the context block.

#### `toArray(): array`
Returns the block as an array. Throws `LogicException` if there are no elements or more than 10 elements.

### Example
```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Deploy finished')
    ->contextBlock(function ($block) {
        $block->id('deploy_context')
            ->image('https://example.com/deploy-status.png', 'Deploy status')
            ->text('Deployed by <@U1234>')
            ->text('2024-01-15 10:00 UTC');
    });
```
```

--------------------------------

### ActionsBlock::usersSelect()

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Creates a new UsersSelectElement, registers it in the block, and returns it for further configuration. The placeholder text is required.

```APIDOC
## ActionsBlock::usersSelect()

### Description
Creates a new UsersSelectElement, registers it in the block, and returns it for further configuration. The placeholder text is required.

### Method
usersSelect

### Signature
public function usersSelect(string $text): UsersSelectElement

### Parameters
- **$text** (string) - Required - The placeholder text for the select.

### Return Value
- **UsersSelectElement** - The created users select element, already registered in the block.
```

--------------------------------

### SelectOption Constructor

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

The constructor for creating a new select option instance, requiring a text label and a value.

```php
/**
 * Create a new select option instance.
 */
public function __construct(string $text, mixed $value)
```

--------------------------------

### send method implementation for SlackChannel

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackChannel.md

Builds the payload, validates the channel and token, posts to chat.postMessage, and throws on Slack API errors. Throws LogicException if channel or token is missing, RequestException on HTTP errors, and RuntimeException on business-level errors.

```php
$route = $this->determineRoute($notifiable, $notification);

$message = $notification->toSlack($notifiable);

$payload = $this->buildJsonPayload($message, $route);

if (! $payload['channel']) {
    throw new LogicException('Slack notification channel is not set.');
}

if (! $route->token) {
    throw new LogicException('Slack API authentication token is not set.');
}

$response = $this->http->asJson()
    ->withToken($route->token)
    ->post('https://slack.com/api/chat.postMessage', $payload)
    ->throw();

if ($response->successful() && $response->json('ok') === false) {
    throw new RuntimeException('Slack API call failed with error ['.$response->json('error').'].');
}

return $response;
```

--------------------------------

### ConfirmObject::__construct

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Composites.md

Creates a new ConfirmObject instance with default title, text, confirm, and deny labels.

```APIDOC
## `ConfirmObject::__construct`

### Description
Creates a new confirm object instance with default values for title, text, confirm, and deny labels.

### Method
`__construct`

### Signature
```php
public function __construct(string $text = 'Please confirm this action.')
```

### Parameters
- **$text** (string) - Optional - The confirmation text. Defaults to `'Please confirm this action.'`.

### Defaults Applied
- `title`: `'Are you sure?'`
- `text`: `$text`
- `confirm`: `'Yes'`
- `deny`: `'No'`

### Example
```php
$confirm = new ConfirmObject('Continue?');
// title: 'Are you sure?', text: 'Continue?', confirm: 'Yes', deny: 'No'
```
```

--------------------------------

### Configure Slack notifications in config/services.php

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/configuration.md

Typical host application configuration for the Slack notification channel. Sets the default bot user OAuth token and channel, read by the package via Config::get. The package itself never calls env(); environment variables are resolved by the host application's config files.

```php
// config/services.php
return [
    // ...
    'slack' => [
        'notifications' => [
            'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
            'channel' => env('SLACK_NOTIFICATION_CHANNEL'),
        ],
    ],
];
```

--------------------------------

### UsersSelectElement Methods

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

Methods for setting the initial user and converting the element to an array representation.

```php
public function initialUser(string $value): self

public function toArray(): array
```

--------------------------------

### SelectElement method signatures

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

Lists the public methods of the abstract SelectElement class: id, placeholder, focus, and toArray. These methods configure the action_id, placeholder text, focus_on_load, and serialization.

```php
public function id(string $id): self

public function placeholder(string $text): self

public function focus(bool $focus = true): self

public function toArray(): array
```

--------------------------------

### Constructor with doc block

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackNotificationRouterChannel.md

The constructor accepts the Laravel application container, used to resolve concrete channel instances.

```php
/**
 * Create a new Slack notification router channel.
 *
 * @param  \Illuminate\Contracts\Foundation\Application  $app
 * @return void
 */
public function __construct($app)
```

--------------------------------

### usingBlockKitTemplate() method implementation

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackMessage.md

Merges a raw Block Kit Builder JSON payload into the message. Decodes with JSON_THROW_ON_ERROR, throwing JsonException on malformed JSON. Requires a top-level 'blocks' key, otherwise throws LogicException. Raw arrays are appended verbatim and passed through unchanged in toArray().

```php
$blocks = json_decode($template, true, flags: JSON_THROW_ON_ERROR);

if (! array_key_exists('blocks', $blocks)) {
    throw new LogicException('The blocks array key is missing.');
}

array_push($this->blocks, ...$blocks['blocks']);
```

--------------------------------

### Handling network errors and skipping empty routes

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackWebhookChannel.md

Shows two scenarios: catching a ConnectException when the webhook is unreachable, and returning a falsy route to silently skip sending without an HTTP request.

```php
use GuzzleHttp\Exception\ConnectException;
use Illuminate\Notifications\Messages\SlackMessage;

// 1) Transport/network failure — Guzzle exceptions propagate from send():
try {
    Notification::route('slack', $webhookUrl)->notify($notification);
} catch (ConnectException $e) {
    // Could not reach the webhook endpoint.
}

// 2) Silent skip — an empty route returns null:
class Customer
{
    public function routeNotificationForSlack()
    {
        return ''; // falsy → send() returns null without any HTTP request
    }
}
```

--------------------------------

### Method signatures

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackAttachmentField.md

Exact method signatures from the source for title(), content(), long(), and toArray().

```php
public function title($title)

public function content($content)

public function long()

public function toArray()
```

--------------------------------

### ImageBlock

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-ImageBlock.md

Documentation for the ImageBlock class, including constructor, methods, and serialization behavior.

```APIDOC
## ImageBlock

### Description
Creates an image block for Slack messages with a URL, alt text, and optional title. The block is added to a Slack message via `SlackMessage::imageBlock(...)`.

### Constructor
`__construct(string $url, ?string $altText = null)`

#### Parameters
- **$url** (string) - Required - Image URL, max 3000 characters. Throws `InvalidArgumentException` if exceeded.
- **$altText** (?string) - Optional - Plain-text summary. Required at serialization time.

### Methods

#### `id(string $id): self`
Sets the `block_id` for the block.

#### `alt(string $altText): self`
Sets the alt text. Max 2000 characters; throws `InvalidArgumentException` if exceeded.

#### `title(string $title): PlainTextOnlyTextObject`
Sets the block title (max 2000 characters via the text object) and returns the text object for chaining (e.g., `emoji()`).

#### `toArray(): array`
Serializes the block to an array. Throws `InvalidArgumentException` if `block_id` exceeds 255 characters, or `LogicException` if alt text is missing.

### Example
```php
use Illuminate\Notifications\Slack\SlackMessage;
use Illuminate\Notifications\Slack\BlockKit\Blocks\ImageBlock;

$message = (new SlackMessage)
    ->text('Deployment chart')
    ->imageBlock('https://example.com/charts/deploy-42.png', 'Deployment success rate', function (ImageBlock $image) {
        $image->id('chart_image')
            ->title('Deploy rate')->emoji();
    });

// Overload variant — closure as second argument (alt text omitted):
$message = (new SlackMessage)
    ->text('Chart')
    ->imageBlock('https://example.com/chart.png', function (ImageBlock $image) {
        $image->alt('Chart');
    });

// Alt text is mandatory — serialization throws if missing:
try {
    (new ImageBlock('https://example.com/image.png'))->toArray();
} catch (\LogicException $e) {
    // 'Alt text is required for an image block.'
}
```
```

--------------------------------

### ImageElement constructor signature

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Elements.md

Constructor for ImageElement. Requires a URL and optional alt text. Alt text is required at serialization.

```php
/**
 * Create a new image element instance.
 */
public function __construct(string $url, ?string $altText = null)
```

--------------------------------

### ConfirmObject constructor with default values

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Composites.md

The constructor accepts an optional text string, defaulting to 'Please confirm this action.'. The defaults applied are title 'Are you sure?', text from the parameter, confirm 'Yes', and deny 'No'.

```php
public function __construct(string $text = 'Please confirm this action.')
```

```php
$this->title('Are you sure?');
$this->text($text);
$this->confirm('Yes');
$this->deny('No');
```

--------------------------------

### Routing conditions for determineChannel()

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackNotificationRouterChannel.md

Exact routing conditions: UriInterface or HTTP(S) string routes to webhook, otherwise to Web API.

```php
if ($route instanceof UriInterface) {
    return $this->app->make(SlackWebhookChannel::class);
}

if (is_string($route) && Str::startsWith($route, ['http://', 'https://'])) {
    return $this->app->make(SlackWebhookChannel::class);
}

return $this->app->make(SlackWebApiChannel::class);
```

--------------------------------

### ActionsBlock::staticSelect()

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Creates a new StaticSelectElement, registers it in the block, and returns it for further configuration. The placeholder text is required.

```APIDOC
## ActionsBlock::staticSelect()

### Description
Creates a new StaticSelectElement, registers it in the block, and returns it for further configuration. The placeholder text is required.

### Method
staticSelect

### Signature
public function staticSelect(string $text): StaticSelectElement

### Parameters
- **$text** (string) - Required - The placeholder text for the select.

### Return Value
- **StaticSelectElement** - The created static select element, already registered in the block.
```

--------------------------------

### StaticSelectElement::initialOption

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

Sets the initial selected option by value, throwing an exception for unknown values.

```APIDOC
## `StaticSelectElement::initialOption`

### Description
Sets the initial selected option by value, throwing an exception for unknown values.

### Method
`public function initialOption(string $value): self`

### Parameters
- **$value** (string) - Required - The value of an option previously added via `addOption`.

### Request Example
```php
$select->initialOption('production');
```

### Response
#### Success Response
- Returns `$this` for chaining.

#### Error Handling
- Throws `InvalidArgumentException` if the value does not match any added option.

#### Response Example
```php
$select // StaticSelectElement instance
```
```

--------------------------------

### ActionsBlock::button()

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Creates a new ButtonElement, registers it in the block, and returns it for further configuration. The button text is required.

```APIDOC
## ActionsBlock::button()

### Description
Creates a new ButtonElement, registers it in the block, and returns it for further configuration. The button text is required.

### Method
button

### Signature
public function button(string $text): ButtonElement

### Parameters
- **$text** (string) - Required - The button label.

### Return Value
- **ButtonElement** - The created button element, already registered in the block.
```

--------------------------------

### SlackRoute Class

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackRoute.md

Documentation for the SlackRoute value object, including its constructor and static factory method.

```APIDOC
## `SlackRoute::__construct(?string $channel = null, ?string $token = null)`

### Description
Creates a new Slack route instance. This value object is returned by `routeNotificationFor('slack', $notification)` to control the Web API transport, allowing a notifiable to override both the destination channel and the OAuth token per-notification.

### Method
Constructor

### Parameters
- **$channel** (?string) - Optional - Destination channel name. Defaults to `null`.
- **$token** (?string) - Optional - OAuth token (typically `xoxb-…` bot token). Defaults to `null`.

### Usage Example
```php
$route = new SlackRoute('deployments', 'xoxb-1234567890-abcdefghij');
```
```

```APIDOC
## `SlackRoute::make(?string $channel = null, ?string $token = null): self`

### Description
Static factory method that fluently creates a new Slack route instance. Equivalent to `new SlackRoute($channel, $token)`.

### Method
Static Factory

### Parameters
- **$channel** (?string) - Optional - Destination channel name. Defaults to `null`.
- **$token** (?string) - Optional - OAuth token (typically `xoxb-…` bot token). Defaults to `null`.

### Return Value
- **self** - A new `SlackRoute` instance.

### Usage Example
```php
$route = SlackRoute::make('deployments', 'xoxb-1234567890-abcdefghij');
```
```

--------------------------------

### SlackChannel::__construct(Factory $http)

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackChannel.md

Creates a new Slack channel instance with the injected HTTP client factory used to build the chat.postMessage request.

```APIDOC
## SlackChannel::__construct(Factory $http)

### Description
Creates a new Slack channel instance. The injected HTTP client factory is used to build the chat.postMessage request.

### Method
Constructor

### Parameters
- **$http** (Illuminate\Http\Client\Factory) - Required - Laravel's HTTP client factory used to build the chat.postMessage request.

### Returns
void
```

--------------------------------

### Basic usage with default token and per-notifiable channel

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/SlackChannel.md

Defines a notification class that sends a warning message to the '#alerts' channel using the default token from the config file. The config file sets the bot user OAuth token and default channel from environment variables. Trigger the notification with $user->notify(new ServerAlert()).

```php
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Slack\SlackMessage;

class ServerAlert extends Notification
{
    public function via($notifiable)
    {
        return ['slack'];
    }

    public function toSlack($notifiable)
    {
        return (new SlackMessage)
            ->to('#alerts')
            ->warning()
            ->text('Disk usage above 90% on web-01.');
    }
}

// config file (config/services.php):
// 'slack' => [
//     'notifications' => [
//         'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
//         'channel' => env('SLACK_NOTIFICATION_CHANNEL'),
//     ],
// ],

$user->notify(new ServerAlert());
```

--------------------------------

### ActionsBlock usage and max elements guard

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Blocks.md

Builds a Slack message with an actions block containing two buttons and a static select. The second part demonstrates the maximum elements guard by adding 26 buttons and catching the LogicException.

```php
use Illuminate\Notifications\Slack\SlackMessage;

$message = (new SlackMessage)
    ->text('Approve the release?')
    ->actionsBlock(function ($block) {
        $block->id('release_actions')
            ->button('Approve')->primary()->value('approve')
            ->button('Reject')->danger()->confirm('Reject this release?')
            ->staticSelect('Choose milestone')->addOption('v1.0', 'v1.0')->initialOption('v1.0');
    });

// Max elements guard:
try {
    $block = (new \Illuminate\Notifications\Slack\BlockKit\Blocks\ActionsBlock);
    for ($i = 0; $i < 26; $i++) {
        $block->button("Button $i");
    }
    $block->toArray();
} catch (\LogicException $e) {
    // 'There is a maximum of 25 elements in each actions block.'
}
```

--------------------------------

### StaticSelectElement initialOption Validation

Source: https://github.com/laravel/slack-notification-channel/blob/3.x/_autodocs/api-reference/BlockKit-Selects.md

The implementation of the initialOption method, which validates that the provided value exists in the options list.

```php
public function initialOption(string $value): self
{
    $option = $this->options[$value] ?? null;

    if ($option === null) {
        throw new InvalidArgumentException("Unknown option value: $value.");
    }

    $this->initialOption = $option;

    return $this;
}
```
Tokens:
Raw