跳到主要内容

Discord notification

Learn how to add and configure the \"Discord\" notification action in your Buddy pipeline

提示

Learn more about:

POST参数

信息

Buddy所有操作通用参数列表

名称类型描述
name
必填		String操作名称
type
必填		StringThe type of the action. Should be set to DISCORD.
notification_url
必填		StringThe URL do the desired Discord webhook.
contentStringThe content of the notification.
attachmentsStringThe embedded rich content. More info here.
file_attachmentsString[]The attached files.

示例

请求

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

JSON

{
  "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_EXECUTION_URL\",\"fields\":[{\"name\":\"Status\",\"value\":\"Successful execution\"},{\"name\":\"Revision\",\"value\":\"$BUDDY_EXECUTION_REVISION\"},{\"name\":\"Pipeline\",\"value\":\"$BUDDY_PIPELINE_NAME\"},{\"name\":\"Project\",\"value\":\"$BUDDY_PROJECT_NAME\"}]}"
    ],
}

示例响应

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": "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"
  }
}