Sms notification

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

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequired string

The workspace name.

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 SMS.

recipientsrequired string

The recipients of the notification: phone numbers (one per line).

contentstring

The content of the notification.

Last modified on Apr 8, 2025

Previous pageSleep Next pageSnyk

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
 -H "Authorization: Bearer <YOUR-TOKEN>" \
 -H "Content-Type: application/json" \
 -d '{
 "name": "SMS Action",
 "type": "SMS",
 "content": "Pipeline executed successfully!",
 "recipients": "11234567890\n12345678901"
}'

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

STATUS
 201 Created

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