Slack Channel

The Slack channel allows you to send notifications to Slack channels via webhooks. This channel is built on top of the Webhook channel and supports all webhook features.

Configuration

import { defineConfig } from 'facteur'
import { slackWebhookChannel } from '@facteurjs/adonisjs/channels/slack'

export default defineConfig({
  channels: {
    slack: slackWebhookChannel({
      // You can define multiple Slack webhooks, each with a unique name
      webhooks: {
        general: 'https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK',
        alerts: 'https://hooks.slack.com/services/YOUR/ALERT/WEBHOOK',
        marketing: 'https://hooks.slack.com/services/YOUR/MARKETING/WEBHOOK',
      },

      // Or just a single default webhook
      webhookUrl: 'https://hooks.slack.com/services/YOUR/DEFAULT/WEBHOOK',
    })
  },
})

You can define multiple Slack webhooks, each with a unique name, or just a single default webhook. This is useful when you want to send certain notifications to specific Slack channels.

Configuration Options

Since the Slack channel uses the webhook channel internally, it supports the same configuration options:

webhooks (optional): An object defining multiple named Slack webhooks
webhookUrl (optional): A single default Slack webhook URL

You must provide either webhooks or webhookUrl.

Targets

The Slack channel targets work exactly like webhook targets:

facteur.send({
  notification: MyNotification,
  via: {
    slack: {
      // Send to specific named webhooks
      general: true,
      alerts: false,
      marketing: true
    }

    // Or send to an arbitrary Slack webhook URL
    slack: {
      webhookUrl: 'https://hooks.slack.com/services/CUSTOM/TENANT/WEBHOOK'
    }
  }
})

Target Properties

Named webhooks: Boolean values for each webhook defined in configuration
webhookUrl (optional): Send to an arbitrary Slack webhook URL

Slack Message Features

When creating notifications for Slack, you can use rich formatting features:

export default class SlackNotification extends Notification {
  asSlackMessage() {
    return SlackMessage.create()
      .setText('Hello from Facteur!')
      .addBlock(/* Slack block kit components */)
      .setChannel('#general')
      .setUsername('Bot Name')
      .setIconEmoji(':robot_face:')
  }
}