SlackIncomingWebhook
SlackIncomingWebhook
yaml
type: "io.kestra.plugin.notifications.slack.SlackIncomingWebhook"
Send a Slack message using an Incoming Webhook
Add this task to send direct Slack notifications. Check the Slack documentation for more details..
Examples
Send a Slack 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.slack.SlackIncomingWebhook
url: "{{ secret('SLACK_WEBHOOK') }}" # https://hooks.slack.com/services/xzy/xyz/xyz
payload: |
{
"text": "Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}"
}
Send a Slack message via incoming webhook with a text argument
yaml
id: slack_incoming_webhook
namespace: company.team
tasks:
- id: send_slack_message
type: io.kestra.plugin.notifications.slack.SlackIncomingWebhook
url: "{{ secret('SLACK_WEBHOOK') }}"
payload: |
{
"text": "Hello from the workflow {{ flow.id }}"
}
Send a Slack message via incoming webhook with a blocks argument, read more on blocks here
yaml
id: slack_incoming_webhook
namespace: company.team
tasks:
- id: send_slack_message
type: io.kestra.plugin.notifications.slack.SlackIncomingWebhook
url: "{{ secret('SLACK_WEBHOOK') }}"
payload: |
{
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "Hello from the workflow *{{ flow.id }}*"
}
}
]
}
Send a Rocket.Chat message via incoming webhook
yaml
id: rocket_chat_notification
namespace: company.team
tasks:
- id: send_rocket_chat_message
type: io.kestra.plugin.notifications.slack.SlackIncomingWebhook
url: "{{ secret('ROCKET_CHAT_WEBHOOK') }}"
payload: |
{
"alias": "Kestra TEST",
"avatar": "https://avatars.githubusercontent.com/u/59033362?s=48",
"emoji": ":smirk:",
"roomId": "#my-channel",
"text": "Sample",
"tmshow": true,
"attachments": [
{
"collapsed": false,
"color": "#ff0000",
"text": "Yay!",
"title": "Attachment Example",
"title_link": "https://rocket.chat",
"title_link_download": false,
"fields": [
{
"short": false,
"title": "Test title",
"value": "Test value"
},
{
"short": true,
"title": "Test title",
"value": "Test value"
}
]
}
]
}
Properties
url
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
Slack incoming webhook URL
Check the Create an Incoming Webhook documentation for more details..
options
- Type: AbstractHttpOptionsTask-RequestOptions
- Dynamic: ✔️
- Required: ❌
Options
The options to set to customize the HTTP client
payload
- Type: string
- Dynamic: ✔️
- Required: ❌
Slack message payload
Definitions
java.nio.charset.Charset
Properties
io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions
Properties
connectTimeout
- Type:
- string
- string
- Dynamic: ✔️
- Required: ❌
connectionPoolIdleTimeout
- Type:
- string
- string
- Dynamic: ✔️
- Required: ❌
defaultCharset
- Type:
- Charset
- string
- Dynamic: ✔️
- Required: ❌
maxContentLength
- Type:
- integer
- string
- Dynamic: ✔️
- Required: ❌
readIdleTimeout
- Type:
- string
- string
- Dynamic: ✔️
- Required: ❌
readTimeout
- Type:
- string
- string
- Dynamic: ✔️
- Required: ❌
Was this page helpful?