Email notification

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to EMAIL.
recipients
Required
StringThe recipients of the notification: email addresses (one per line).
contentStringThe content of the notification.
titleStringThe title of the notification.
send_as_htmlBooleanDefines whether to send the content as HTML.
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": "emailTitle",
"value": "Pipeline executed successfully!"
}
]
"file_attachments": [
"fs:///file1",
"fs:///file2"
]
"content": "<b>${BUDDY_PIPELINE_NAME}</b> execution #${BUDDY_EXECUTION_ID}"
"recipients": "admin@mailinator.com\nmanage@mailinator.com",
"title": "$emailTitle",
"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": "emailTitle",
"value": "Pipeline executed successfully!"
}
],
"file_attachments": [
"fs:///file1",
"fs:///file2"
]
"last_execution_status": "INITIAL",
"title": "$emailTitle",
"content": "<b>${BUDDY_PIPELINE_NAME}</b> execution #${BUDDY_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"
}
}