Email notification

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
recipients
Required
StringThe recipients of the notification: email addresses (one per line).
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to EMAIL.
contentStringThe content of the notification.
titleStringThe title of the notification.
run_only_on_first_failureBooleanDefines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
send_as_htmlBooleanDefines whether to send the content as HTML.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
variablesVariable []The list of variables defined for this action.
file_attachmentsString[]The attached files.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "EMAIL Action",
"type": "EMAIL",
"trigger_time": "ON_EVERY_EXECUTION",
"variables": [
{
"key": "ftp_login",
"value": "userLogin123",
"description": "The name of user to FTP.",
"encrypted": false,
"settable": false
},
{
"key": "ftp_password",
"value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
"description": "The password for ftp.",
"encrypted": true
}
]
"file_attachments": [
"fs:///file1",
"fs:///file2"
]
"content": "<b>${execution.pipeline.name}</b> execution #${execution.id}"
"recipients": "admin@mailinator.com\nmanage@mailinator.com",
"title": "Pipeline executed successfully!",
"send_as_html": true
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
"id": 2,
"name": "EMAIL Action",
"type": "EMAIL",
"trigger_time": "ON_EVERY_EXECUTION",
"variables": [
{
"key": "ftp_login",
"value": "userLogin123",
"description": "The name of user to FTP.",
"encrypted": false,
"settable": false
},
{
"key": "ftp_password",
"value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
"description": "The password for ftp.",
"encrypted": true
}
]
"file_attachments": [
"fs:///file1",
"fs:///file2"
]
"last_execution_status": "INITIAL",
"run_only_on_first_failure": false,
"title": "Pipeline executed successfully!",
"content": "<b>${execution.pipeline.name}</b> execution #${execution.id}"
"recipients": "admin@mailinator.com\nmanage@mailinator.com",
"send_as_html": true,
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}