YAML for Telegram notification

View as Markdown

Send a message to a Telegram chat.

YAML parameters for Telegram notification

PARAMETERS
integrationrequiredstring
Telegram integration (TELEGRAM). It refers to an integration in the workspace by its identifier, not by its display name.
contentrequiredstring
Message content to send. Supports Markdown and Buddy variables.
typerequiredstring

Value: TELEGRAM

actionrequiredstring
Unique identifier for the action within the pipeline.
parse_modestring enum
The parsing mode for the message
Allowed enum:
PLAIN_TEXT,
MARKDOWN,
HTML
file_attachmentsstring[]
The list of file attachment paths
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
When true, the action runs only on the first failure instead of on each failure. Used only when trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds. It cannot exceed the action time limit of the workspace plan; a higher value is rejected.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.

Constraints: ≤ 10

run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Nov 2, 2026

YAML examples for Telegram notification

Telegram notification with attachments

yaml
- action: Send Telegram notification
  type: TELEGRAM
  integration: "my-telegram-integration"
  trigger_time: ON_EVERY_EXECUTION
  disabled: false
  content: |-
    Deployment to *$BUDDY_RUN_BRANCH* completed!

    Revision: `$BUDDY_RUN_COMMIT`
    Triggered by: $BUDDY_INVOKER_NAME
  parse_mode: MARKDOWN
  file_attachments:
    - /logs/build.log
    - /reports/test-results.xml
  ignore_errors: false
  retry_interval: 30
  retry_count: 2
  timeout: 60

Simple Telegram notification

yaml
- action: Telegram notify
  type: TELEGRAM
  integration: "my-telegram-integration"
  trigger_time: ON_EVERY_EXECUTION
  content: Build completed successfully