DiscordIncomingWebhook​Discord​Incoming​Webhook

Send a Discord message using an Incoming Webhook.

Add this task to a list of errors tasks to implement custom flow-level failure notifications. Check the Discord documentation for more details.

yaml
type: "io.kestra.plugin.notifications.discord.DiscordIncomingWebhook"

Send a Discord notification on a failed flow execution.

yaml
id: unreliable_flow
namespace: company.team

tasks:
  - id: fail
    type: io.kestra.plugin.scripts.shell.Commands
    runner: PROCESS
    commands:
      - exit 1

errors:
  - id: alert_on_failure
    type: io.kestra.plugin.notifications.discord.DiscordIncomingWebhook
    url: "{{ secret('DISCORD_WEBHOOK') }}" # https://discord.com/api/webhooks/000000/xxxxxxxxxxx
    payload: |
      {
        "username": "MyUsername",
        "content": "Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}",
        "embedList": [{
                "title": "Discord Notification"
            }]
      }

Send a Discord message via incoming webhook.

yaml
id: discord_incoming_webhook
namespace: company.team

tasks:
  - id: send_discord_message
    type: io.kestra.plugin.notifications.discord.DiscordIncomingWebhook
    url: "{{ secret('DISCORD_WEBHOOK') }}"
    payload: |
      {
        "username": "MyUsername",
        "tts": false,
        "content": "Hello from the workflow {{ flow.id }}",
        "embeds": [
            {
                "title": "Hello from Kestra",
                "color": 16777215,
                "description": "This is a test message from Kestra",
                "footer": {
                    "text": "Footer text"
                }
            }
        ]
      }
Properties
Min length 1

Webhook URL which should be taken from discord integrations tab.

Options

The options to set to customize the HTTP client

Discord message payload

Format duration

The time allowed to establish a connection to the server before failing.

Default PT0S
Format duration

The time an idle connection can remain in the client's connection pool before being closed.

Default UTF-8

The default charset for the request.

SubType string

HTTP headers

HTTP headers to include in the request

Default 10485760

The maximum content length of the response.

Default PT5M
Format duration

The time allowed for a read connection to remain idle before closing it.

Default PT10S
Format duration

The maximum time allowed for reading data from the server before failing.