TelegramExecution

Send a Telegram 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 TelegramSend task.

yaml
type: "io.kestra.plugin.notifications.telegram.TelegramExecution"

Examples

Send a Telegram notification on a failed flow execution.

yaml
id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.telegram.TelegramExecution
    token: "{{ secret('TELEGRAM_TOKEN') }}" # format: 6090305634:xyz
    channel: "2072728690"
    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

channel *string

Telegram channel/user ID

token *string

Telegram Bot token

customFields object

Custom fields to be added on notification

customMessage string

Custom message to be added on notification

endpointOverride string

Only to be used when testing locally

executionId string

Default {{ execution.id }}

The execution id to use

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

options AbstractHttpOptionsTask-RequestOptions

Options

The options to set to customize the HTTP client

parseMode string

Possible Values

HTMLMARKDOWNV2

Telegram Bot parse-Mode

Optional text formatting mode for Telegram messages. Supported values: HTML, Markdown, MarkdownV2.

payload string

Message payload

templateRenderMap object

Map of variables to use for the message template (Unused in the default template)

Definitions

java.nio.charset.Charset

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

connectTimeout string

Format duration

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

connectionPoolIdleTimeout string

Default PT0S

Format duration

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

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

headers object

SubType string

HTTP headers

HTTP headers to include in the request

maxContentLength integerstring

Default 10485760

The maximum content length of the response.

readIdleTimeout string

Default PT5M

Format duration

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

readTimeout string

Default PT10S

Format duration

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

​Telegram​Execution

TelegramExecution