TelegramExecution TelegramExecution

yaml
type: "io.kestra.plugin.notifications.telegram.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, 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 TelegramSend task.

Examples

Send a Telegram notification on a failed flow execution

yaml
id: failure_alert
namespace: prod.monitoring

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.core.models.triggers.types.Flow
    conditions:
      - type: io.kestra.core.models.conditions.types.ExecutionStatusCondition
        in:
          - FAILED
          - WARNING
      - type: io.kestra.core.models.conditions.types.ExecutionNamespaceCondition
        namespace: prod
        prefix: true

Properties

channel

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

Telegram channel/user ID

token

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

Telegram Bot token

customFields

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

Custom fields to be added on notification

customMessage

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

Custom message to be added on notification

endpointOverride

  • Type: string
  • Dynamic:
  • Required:

Only to be used when testing locally

executionId

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

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.

payload

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

Message payload

templateRenderMap

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

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

Was this page helpful?