This guide outlines Discord webhooks integration setup, and installation and configuration of the Discord service and channel.

Installation

From a project with a pre-installed version of Notifier and Notifier Chat Channel, bring in the Discord notifier dependency:

composer require symfony/discord-notifier

Creating a Discord Webhook Integration

A Webhook app must be created, and a unique https://discord.com/api/webhooks/ webhook issued, in order to use this integration.

1. Go to Server Settings on an existing Discord server.

2. Click Integrations in the sidebar, under Apps.

3. Click Webhooks section.

   

4. Click New Webhook button.

5. Click the newly created Webhook, then click Copy Webhook URL button.

Keep the URL for transport configuration.

Configuration

In the site directory, usually sites/default/, create a services.yml file.

Add to settings.php:

$settings['container_yamls'][] = __DIR__ . '/services.yml';

Add to services.yml:

parameters:
  chatter.transports:
    my_discord_transport: 'discord://TOKEN@default?webhook_id=ID'

Modify the DSN by replacing TOKEN and ID with parts from a previously created webhook URL.

Webhook URL

A webhook URL looks like: https://discord.com/api/webhooks/{webhook_id}/{webhook_token}

e.g. https://discord.com/api/webhooks/a1b2c3d4e4a1b2c3d4e4/12345678987654321123456789876543211234567898765432112345678987654321

The first set of characters is the webhook ID, the second and longer set of characters is the webhook TOKEN.

So the above example webhook URL converted to a DSN will be: discord://12345678987654321123456789876543211234567898765432112345678987654321@default?webhook_id=a1b2c3d4e4a1b2c3d4e4

Then clear Drupal caches:

drush cr

Sending

To send a message to a Discord channel, create a notification then send to the notifier service.

Pass the name of the Discord transport as configured in chatter.transports to the Notification::channels() method, prefixed with chat/.

Message body

Chat notifications use subject() for message contents, not contents().

src/MyService.php

namespace Drupal\my_module;

final class MyService {
  public function __construct(
    private readonly \Symfony\Component\Notifier\NotifierInterface $notifier,
  ) {}
  public function myMethod(){
    $notification = (new \Symfony\Component\Notifier\Notification\Notification())
      ->subject('Test message!')
      # Specify the name of the Discord transport as configured in `chatter.transports`.
      ->channels(['chat/my_discord_transport']),
    $this->notifier->send($notification);
  }
}

mymodule.services.yml

services:
  _defaults:
    autowire: true
    
  my_service:
    class: Drupal\my_module\MyService

Discord Options

The Discord transport supports a variety of rich elements. The list of supported extras can be found in the Discord transport README. To make use of these, create a custom Notification object which extends ChatNotificationInterface, and return a ChatMessage object with a \Symfony\Component\Notifier\Bridge\Discord\DiscordOptions options object passed along.

src/MyDiscordNotification.php

namespace Drupal\my_module;

use Symfony\Component\Notifier\Bridge\Discord\DiscordOptions;
use Symfony\Component\Notifier\Bridge\Discord\Embeds\DiscordEmbed;
use Symfony\Component\Notifier\Bridge\Discord\Embeds\DiscordMediaEmbedObject;
use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
use Symfony\Component\Notifier\Notification\Notification;
use Symfony\Component\Notifier\Recipient\RecipientInterface;

final class MyDiscordNotification extends Notification implements ChatNotificationInterface {
  public function asChatMessage(RecipientInterface $recipient, ?string $transport = null): ?ChatMessage {
    $discordOptions = (new DiscordOptions())
      ->username('Bender')
      ->addEmbed((new DiscordEmbed())
        ->title('Test!')
        ->image(
          (new DiscordMediaEmbedObject())
            ->url('https://picsum.photos/seed/picsum/800/400')
            ->width(800)
            ->height(400)
        ),
      );

    return new ChatMessage('', $discordOptions);
  }
}

src/MyService.php

namespace Drupal\my_module;

final class MyService {
  public function __construct(
    private readonly \Symfony\Component\Notifier\NotifierInterface $notifier,
  ) {}
  public function myMethod(){
    # Use notification class:
    $this->notifier->send(new \Drupal\my_module\MyDiscordNotification());
  }
}

---

This documentation is not provided or endorsed by Discord.