Sms 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 SMS.
recipients
Required
StringThe recipients of the notification: phone numbers (one per line).
contentStringThe content of the notification.

Example

Request

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

JSON

{
"name": "SMS Action",
"type": "SMS",
"content": "Pipeline executed successfully!",
"recipients": "11234567890\n12345678901"
}

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/21",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "SMS Action",
"type": "SMS",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"status": "INITIAL",
"recipients": "11234567890\n12345678901",
"content": "Pipeline executed successfully!",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
"id": 1,
"name": "test server",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}