Sign in

v4

OpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Webhook API

Creates a new webhook. Restricted to admins only.

post/workspaces/{workspace_domain}/webhooks

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Request body

target_urlstring required

The URL to which the payload will be sent

secret_keystring

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

namestring

The name of the webhook

projectsstring[]

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

eventsstring[] required

Set of events that trigger the webhook

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idinteger

The ID of the webhook

target_urlstring

The URL to which the payload will be sent

namestring

The name of the webhook

secret_keystring

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

projectsstring[]

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

eventsstring[]

Set of events that trigger the webhook