---
title: "Quick start"
manual: "Laravel-style Notification System - Slack Channel"
version: "1.0"
permalink: "https://docs.typo3.org/permalink/agencelex/notifications-slack:slack-usage@1.0"
source: "Usage/Index.rst"
rendered: "2026-10-16T12:40:55+00:00"
---

# Quick start {#slack-usage}

This example creates a TYPO3 notification and sends it using an on-demand
Slack route. The core notification manager handles channel selection and
dispatch.

## Create a notification {#create-a-notification}

```php
<?php

declare(strict_types=1);

namespace Vendor\Site\Notification;

use Lex\Notifications\Slack\Extension;
use Lex\Notifications\Notification;
use Lex\Notifications\Slack\Domain\Model\Ability\CanSendToSlack;
use Lex\Notifications\Slack\Message\SlackMessage;

final class DeploymentCompleted extends Notification
{
    use CanSendToSlack;

    public function via(object $notifiable): array
    {
        return [Extension::CHANNEL_NAME];
    }

    public function toSlack(object $notifiable): SlackMessage
    {
        return SlackMessage::text(
            ':white_check_mark: *TYPO3 deployment completed*'
        );
    }
}
```

## Send on demand {#send-on-demand}

Inject `Lex\\Notifications\\NotificationDispatcherInterface` into an application
service and choose a route:

```php
<?php

declare(strict_types=1);

namespace Vendor\Site\Service;

use Lex\Notifications\NotificationDispatcherInterface;
use Lex\Notifications\Slack\Configuration\SlackRoute;
use Vendor\Site\Notification\DeploymentCompleted;

final readonly class DeploymentReporter
{
    public function __construct(
        private NotificationDispatcherInterface $dispatcher,
    ) {}

    public function report(): void
    {
        $this->dispatcher
            ->route('slack', SlackRoute::webhookNamed('monitoring'))
            ->notify(new DeploymentCompleted());
    }
}
```

To send via the Web API instead, use:

```php
$this->notifications
    ->route('slack', SlackRoute::api('C0123456789', 'a_bot_token'))
    ->notify(new DeploymentCompleted());
```

The Bot Token is not supplied when building the SlackRoute, it is obtained from [TYPO3 configuration](https://docs.typo3.org/permalink/agencelex/notifications-slack:slack-configuration@1.0).

## Send from a notifiable model {#send-from-a-notifiable-model}

A notifiable domain object can define its own Slack route:

```php
<?php

declare(strict_types=1);

use Lex\Notifications\Domain\Model\Ability\Notifiable;
use Lex\Notifications\Notification;
use Lex\Notifications\Slack\Configuration\SlackRoute;
use Lex\Notifications\Slack\Domain\Model\Ability\HasRouteNotificationForSlack;

final class TeamRecipient
{
    use Notifiable;
    use HasRouteNotificationForSlack;

    public function routeNotificationForSlack(
        ?Notification $notification = null
    ): SlackRoute|string|null {
        return SlackRoute::webhookNamed('monitoring');
    }
}

(new TeamRecipient())->notify(new DeploymentCompleted());
```

A `null` or empty-string Slack route causes the core to skip that
recipient. The `via()` method must include `slack` unless the caller
uses an explicit channel override supported by the core.

## Next steps {#next-steps}

See [Routing](https://docs.typo3.org/permalink/agencelex/notifications-slack:slack-routing@1.0),
[Message formats](https://docs.typo3.org/permalink/agencelex/notifications-slack:slack-message-formats@1.0), and
[Queued notifications](https://docs.typo3.org/permalink/agencelex/notifications-slack:slack-queued-notifications@1.0).