Telegram TelegramSend

Telegram TelegramSend

Certified

Send a Telegram chat message

Posts a Telegram sendMessage request using a Bot token and chat ID. Payload must be valid Telegram JSON; default parse mode sends plain text. Supports HTTP client overrides and an optional API endpoint override for local testing.

yaml
type: io.kestra.plugin.telegram.TelegramSend

Send a Telegram message 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.telegram.TelegramSend
    token: "{{ secret('TELEGRAM_TOKEN') }}" # format: 6090305634:xyz
    channel: "2072728690"
    payload: |
      {
        "text": "Telegram Alert"
      }
Properties

Chat ID or channel ID

Target chat identifier for the user or channel; supports expressions.

Bot access token

Telegram Bot API token; store as a secret and avoid hardcoding.

Custom Telegram API base URL

Override the Telegram API endpoint for local testing; defaults to https://api.telegram.org.

Configure Telegram HTTP client

Optional HTTP client overrides for Telegram calls. Leave unset to use defaults: 10s read timeout, 5m read idle timeout, 10 MB max response, UTF-8 charset.

Definitions
connectTimeoutstring

Maximum time to establish the connection before failing; unset uses the client default.

connectionPoolIdleTimeoutstring
DefaultPT0S

Idle timeout for pooled connections; defaults to 0s.

defaultCharsetstring
DefaultUTF-8

Request charset; defaults to UTF-8.

headersobject

HTTP headers

HTTP headers to include in the request

maxContentLengthintegerstring
Default10485760

Maximum response size; defaults to 10 MB.

readIdleTimeoutstring
DefaultPT5M

Idle time allowed while reading before closing the connection; defaults to 5m.

readTimeoutstring
DefaultPT10S

Maximum read duration before failing; defaults to 10s.

Possible Values
HTMLMARKDOWNV2

Telegram Bot parse-Mode

Optional text formatting mode (HTML or MarkdownV2); default sends plain text.

Message payload

Rendered JSON body passed to Telegram sendMessage (must include text).

Reference (ref) of the pluginDefaults to apply to this task.