Slack notification

View as Markdown

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

Info

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequiredstring

The workspace name.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

project_namerequiredstring

The name ID of the project.

POST PARAMETERS

namerequiredstring

The name of the action.

typerequiredstring

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

channelrequiredstring

The ID of the Slack channel. More info here.

integrationrequiredstring

The integration.

contentstring

The content of the notification.

attachmentsstring[]

The array of the Slack message attachments. More info here.

file_attachmentsstring[]

The attached files.

Last modified on Jan 19, 2026

Sign Bundle Sleep

Request 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": "SLACK Action",
  "type": "SLACK",
  "trigger_time": "ON_EVERY_EXECUTION",
  "content": "Pipeline Execution successful!",
  "channel": "C024BE91L",
  "attachments": [
    "{\"fallback\":\"${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}\",\"color\":\"${color}\",\"fields\":[{\"title\":\"Successful execution\",\"value\":\"<${BUDDY_RUN_URL}|Execution #${BUDDY_RUN_ID} ${BUDDY_RUN_COMMENT}>\",\"short\":true},{\"title\":\"Pipeline\",\"value\":\"<${BUDDY_PIPELINE_URL}|${BUDDY_PIPELINE_NAME}>\",\"short\":true},{\"title\":\"Branch\",\"value\":\"${BUDDY_PIPELINE_NAME}\",\"short\":true}]}"
  ],
  "variables": [
    {
      "key": "color",
      "value": "good"
    }
  ],
  "file_attachments": [
    "fs:///file1",
    "fs:///file2"
  ],
  "integration": {
    "identifier": "5ddb7c180fb38be67bd78a88a"
  }
}'

Response

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit",
  "id": 1,
  "name": "SLACK Action",
  "type": "SLACK",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "content": "Pipeline Execution successful!",
  "channel": "C024BE91L",
  "attachments": [
    "{\"fallback\":\"${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}\",\"color\":\"${color}\",\"fields\":[{\"title\":\"Successful execution\",\"value\":\"<${BUDDY_RUN_URL}|Execution #${BUDDY_RUN_ID} ${BUDDY_RUN_COMMENT}>\",\"short\":true},{\"title\":\"Pipeline\",\"value\":\"<${BUDDY_PIPELINE_URL}|${BUDDY_PIPELINE_NAME}>\",\"short\":true},{\"title\":\"Branch\",\"value\":\"${BUDDY_PIPELINE_NAME}\",\"short\":true}]}"
  ],
  "variables": [
    {
      "key": "color",
      "value": "good"
    }
  ],
  "file_attachments": [
    "fs:///file1",
    "fs:///file2"
  ],
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/integrations",
    "identifier": "5ddb7c180fb38be67bd78a88a"
  },
  "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