Slack notification

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

NameTypeDescription
name
Required		StringThe name of the action.
type
Required		StringThe type of the action. Should be set to SLACK.
channel
Required		StringThe ID of the Slack channel. More info here.
integration
Required		StringThe integration.
contentStringThe content of the notification.
attachmentsString[]The array of the Slack message attachments. More info here.
file_attachmentsString[]The attached files.

Example

Request

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

JSON

{
  "name": "SLACK Action",
  "type": "SLACK",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "content": "Pipeline Execution successful!",
  "channel": "C024BE91L",
  "attachments": [
      "{\"fallback\":\"${BUDDY_PIPELINE_NAME} execution #${BUDDY_EXECUTION_ID}\",\"color\":\"${color}\",\"fields\":[{\"title\":\"Successful execution\",\"value\":\"<${BUDDY_EXECUTION_URL}|Execution #${BUDDY_EXECUTION_ID} ${BUDDY_EXECUTION_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": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}

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/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",
  "trigger_condition": "ALWAYS",
  "last_execution_status": "INITIAL",
  "content": "Pipeline Execution successful!",
  "channel": "C024BE91L",
  "attachments": [
      "{\"fallback\":\"${BUDDY_PIPELINE_NAME} execution #${BUDDY_EXECUTION_ID}\",\"color\":\"${color}\",\"fields\":[{\"title\":\"Successful execution\",\"value\":\"<${BUDDY_EXECUTION_URL}|Execution #${BUDDY_EXECUTION_ID} ${BUDDY_EXECUTION_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",
    "hash_id": "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",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.