Slack 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 SLACK.

channelrequired string

The ID of the Slack channel. More info here.

integrationrequired string

The integration.

contentoptional string

The content of the notification.

attachmentsoptional string[]

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

file_attachmentsoptional string[]

The attached files.

Last modified on Oct 7, 2024

Sign Bundle Sleep

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": "SLACK Action",
  "type": "SLACK",
  "trigger_time": "ON_EVERY_EXECUTION",
  "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"
  }
}'

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_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",
    "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