YAML for Email notification

View as Markdown

Send an email notification with custom content and optional attachments.

YAML parameters for Email notification

PARAMETERS
titlerequiredstring
Subject line of the email.
contentrequiredstring
Message content to send. Supports Markdown and Buddy variables.
typerequiredstring

Value: EMAIL

actionrequiredstring
Unique identifier for the action within the pipeline.
tostring[]
Recipients of the email: usernames of workspace members and/or email addresses. Required unless send_to_groups is set.
send_to_groupsstring[]
Names of the workspace groups to send the email to. Each group must be added to the project.
send_as_htmlboolean
When true, send the email as HTML instead of plain text.
from_namestring
Sender name shown in the email.
file_attachmentsstring[]
File paths to attach to the email.
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 Email notification

HTML email with attachments

yaml
- action: Send deployment report
  type: EMAIL
  trigger_time: ON_EVERY_EXECUTION
  disabled: false
  title: Deployment Report - $BUDDY_RUN_BRANCH
  from_name: CI/CD Pipeline
  content: |-
    <h1>Deployment Completed</h1>
    <p>Branch: <strong>$BUDDY_RUN_BRANCH</strong></p>
    <p>Revision: <code>$BUDDY_RUN_COMMIT</code></p>
    <p>Triggered by: $BUDDY_INVOKER_NAME</p>
    <hr>
    <p>View execution: $BUDDY_RUN_URL</p>
  send_as_html: true
  to:
    - john.doe
    - team@example.com
    - devops@example.com
  send_to_groups:
    - Developers
    - DevOps Team
  file_attachments:
    - /artifacts/build-report.html
    - /logs/deployment.log
  ignore_errors: false
  retry_interval: 60
  retry_count: 3
  timeout: 120

Simple email notification

yaml
- action: Email notification
  type: EMAIL
  trigger_time: ON_EVERY_EXECUTION
  title: Build completed
  content: The build has finished successfully.
  to:
    - dev@example.com