TelegramExecution
Send a Telegram message with the execution information.

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

customFieldsobject

Custom fields to be added on notification

customMessagestring

Custom message to be added on notification

endpointOverridestring

Only to be used when testing locally

executionIdstring

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

Options

The options to set to customize the HTTP client

Definitions

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

connectTimeoutstring

Formatduration

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

connectionPoolIdleTimeoutstring

DefaultPT0S

Formatduration

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

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

headersobject

SubTypestring

HTTP headers

HTTP headers to include in the request

maxContentLengthintegerstring

Default10485760

The maximum content length of the response.

readIdleTimeoutstring

DefaultPT5M

Formatduration

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

readTimeoutstring

DefaultPT10S

Formatduration

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

parseModestring

Possible Values

HTMLMARKDOWNV2

Telegram Bot parse-Mode

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

payloadstring

Message payload

templateRenderMapobject

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

Azure

Enterprise

Leverage Microsoft Azure services within Kestra data workflows.

AlertingCloudStorageBatch

ServiceNow

This sub-group of plugins contains tasks for using ServiceNow. ServiceNow allows employees to work the way they want to, not how software dictates they have to.

Alerting