Email notification

Learn more about: - Email action features - Email integrations - Email alternatives

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `EMAIL`.
recipients `Required`	String	The recipients of the notification: email addresses (one per line).
content	String	The content of the notification.
title	String	The title of the notification.
send_as_html	Boolean	Defines whether to send the content as HTML.
file_attachments	String[]	The attached files.
from_name	String	The e-mail sender name.

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",
  "from_name": "Buddy",
  "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",
  "from_name": "Buddy",
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}