Create

POST
/workspaces
/:domain
/webhooks

Creates a new webhook. Restricted to admins only.

Request

REQUIRED SCOPES

WORKSPACE, WEBHOOK_ADD

URL PARAMETERS

domainrequired string

The workspace domain.

POST PARAMETERS

eventsrequired string[]

The array of events describing when the webhook will be executed. Can be set of PUSH, EXECUTION_STARTED, EXECUTION_SUCCESSFUL, EXECUTION_FAILED or EXECUTION_FINISHED.

target_urlrequired string

The URL to which the payload will be sent.

projectsrequired string[]

The array of project name IDs from which webhooks will be executed.

secret_keyrequired string

The value sent in the payload required by the webservice to validate the request.

Last modified on Sep 27, 2024

Delete Get

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/webhooks" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "target_url": "http://localhost",
  "secret_key": "mysecretkey",
  "projects": [
    "company-website",
    "beta-project"
  ],
  "events": [
    "EXECUTION_FAILED"
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/webhooks/2",
  "html_url": "https://app.buddy.works/buddy/webhook/2",
  "id": 2,
  "target_url": "http://localhost",
  "secret_key": "mysecretkey",
  "projects": [
    "company-website",
    "beta-project"
  ],
  "events": [
    "EXECUTION_FAILED"
  ]
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999