PluginsNotificationsTasksDiscordDiscordExecution

DiscordExecution​Discord​Execution

DiscordExecution DiscordExecution

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

Send a Discord message with the execution information

The message will include a link to the execution page in the UI along with the execution ID, namespace, flow name, the start date, duration and the final status of the execution, and (if failed) the task that led to a failure.

Use this notification task only in a flow that has a Flow trigger. Don't use this notification task in errors tasks. Instead, for errors tasks, use the DiscordIncomingWebhook task.

Examples

Send a Discord notification on a failed flow execution

yaml
id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.discord.DiscordExecution
    url: "{{ secret('DISCORD_WEBHOOK') }}" # format: https://hooks.discord.com/services/xzy/xyz/xyz
    username: "MyUsername"
    embedList:
        - title: "Discord Notification"
          color:
              - 255
              - 255
              - 255
    executionId: "{{trigger.executionId}}"

triggers:
  - id: failed_prod_workflows
    type: io.kestra.plugin.core.trigger.Flow
    conditions:
      - type: io.kestra.plugin.core.condition.ExecutionStatusCondition
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespaceCondition
        namespace: prod
        prefix: true

Properties

url

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Webhook URL which should be taken from discord integrations tab

avatarUrl

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Webhook avatar URL

content

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Message content

customFields

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

Custom fields to be added on notification

customMessage

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Custom message to be added on notification

embedList

Adds an embed to the discord notification body

executionId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: {{ execution.id }}

The execution id to use

Default is the current execution, change it to {{ trigger.executionId }} if you use this task with a Flow trigger to use the original execution.

options

Options

The options to set to customize the HTTP client

payload

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Discord message payload

templateRenderMap

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

Map of variables to use for the message template

username

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Webhook username

Definitions

java.nio.charset.Charset

Properties

io.kestra.plugin.notifications.discord.DiscordTemplate-Embed

Properties

authorName
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Message author name

color
  • Type: array
  • SubType: integer
  • Dynamic: ❌
  • Required: ❌

RGB color of text

Example: 255, 255, 255

description
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Message description

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Footer text

thumbnail
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Thumbnail URL

title
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Title

websiteUrl
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Website URL, link title with given URL

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

Properties

connectTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌
connectionPoolIdleTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌
defaultCharset
  • Type:
  • Dynamic: ✔️
  • Required: ❌
maxContentLength
  • Type:
    • integer
    • string
  • Dynamic: ✔️
  • Required: ❌
readIdleTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌
readTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌

Was this page helpful?