Email notification

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to EMAIL.

recipientsrequired string

The recipients of the notification: email addresses (one per line). One of send_to_groups or recipients must be specified.

send_to_groupsrequired string

The list of groups' names to which emails will be sent. One of send_to_groups or recipients must be specified.

contentstring

The content of the notification.

titlestring

The title of the notification.

send_as_htmlboolean

Defines whether to send the content as HTML.

file_attachmentsstring[]

The attached files.

from_namestring

The e-mail sender name.

Last modified on Oct 7, 2024

Elastic Beanstalk Monitor EOS

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "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,
  "send_to_groups": [
    "Managers",
    "Developers"
  ]
}'

EXAMPLE RESPONSE
{
  "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",
    "send_to_groups": [
      "Managers",
      "Developers"
    ]
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999