Discord DiscordExecution
CertifiedSend a Discord message with the execution information
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. If failed, then the task that led to the failure is specified.
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.
type: io.kestra.plugin.discord.DiscordExecutionExamples
Send a Discord notification on a failed flow execution.
id: failure_alert
namespace: company.team
tasks:
- id: send_alert
type: io.kestra.plugin.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.ExecutionStatus
in:
- FAILED
- WARNING
- type: io.kestra.plugin.core.condition.ExecutionNamespace
namespace: prod
prefix: true
Properties
url *string
1Webhook URL, which should be taken from the Discord integrations tab
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150avatarUrl string
Webhook avatar URL
content string
Message content
customFields object
Custom fields
Added as fields of the notification embed, after the customMessage field if it is set. Discord allows at most 25 fields per embed, so if there are more entries, the last field says how many were omitted. Discord also limits a message to 6000 characters in total, so all fields share a budget of 4000 characters and long names and values are shortened.
customMessage string
Custom message to be added on notification
embedList array
Adds an embed to the discord notification body
io.kestra.plugin.discord.DiscordTemplate-Embed
Message author name
RGB color of text
Example: [255, 255, 255]
Message description
Footer text
Thumbnail URL
Title
Website URL, link title with given URL
executionId string
{{ 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
io.kestra.plugin.discord.AbstractDiscordConnection-RequestOptions
The time allowed to establish a connection to the server before failing
PT0SThe time an idle connection can remain in the client's connection pool before being closed
UTF-8The default charset for the request
java.nio.charset.Charset
HTTP headers
HTTP headers to include in the request
10485760The maximum content length of the response
PT5MThe time allowed for a read connection to remain idle before closing it
PT10SThe maximum time allowed for reading data from the server before failing
payload string
Discord message payload
templateRenderMap object
Map of variables to use for the message template
username string
Webhook username
