Discord 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 DISCORD.

notification_urlrequired string

The URL do the desired Discord webhook.

contentstring

The content of the notification.

attachmentsstring

The embedded rich content. More info here.

file_attachmentsstring[]

The attached files.

Last modified on Oct 29, 2024

DigitalOcean Spaces Docker

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": "DISCORD Action",
  "type": "DISCORD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "url",
      "value": "https://discordapp.com/api/webhooks/44946646586372954/gQ0DjPK3caFPa9lUtw9b6BNIanPudvtluHoONkBioN7h1E8S1fx3Rx32QoWcgOJkXtZ"
    }
  ],
  "file_attachments": [
    "fs:///file1",
    "fs:///file2"
  ],
  "content": "Pipeline Execution successful!",
  "notification_url": "$url",
  "attachments": "[{\"title\":\"Details\",\"url\":\"$BUDDY_RUN_URL\",\"fields\":[{\"name\":\"Status\",\"value\":\"Successful execution\"},{\"name\":\"Revision\",\"value\":\"$BUDDY_RUN_COMMIT\"},{\"name\":\"Pipeline\",\"value\":\"$BUDDY_PIPELINE_NAME\"},{\"name\":\"Project\",\"value\":\"$BUDDY_PROJECT_NAME\"}]}]"
}'

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": "DISCORD Action",
  "type": "DISCORD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "url",
      "value": "https://discordapp.com/api/webhooks/44946646586372954/gQ0DjPK3caFPa9lUtw9b6BNIanPudvtluHoONkBioN7h1E8S1fx3Rx32QoWcgOJkXtZ"
    }
  ],
  "file_attachments": [
    "fs:///file1",
    "fs:///file2"
  ],
  "last_execution_status": "INITIAL",
  "content": "Pipeline Execution successful!",
  "notification_url": "$url",
  "embeds": "[{\"title\": \"Topic Title\", \"url\": \"https://example.com\", \"description\": \"This is a test for webhooks\", \"type\": \"link\", \"thumbnail\": {\"url\": \"https://meta-s3-cdn.freetls.fastly.net/original/3X/c/b/cb4bec8901221d4a646e45e1fa03db3a65e17f59.png\"}}]",
  "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