Edit webhook

Updates a webhook. Restricted to admins only.

Required scopes: WORKSPACE, WEBHOOK_MANAGE

Resource URL

PATCH /workspaces/:domain/webhooks/:webhook_id

URL Parameters

NameStringDescription
domain
Required
StringThe workspace domain.
webhook_id
Required
IntegerThe numerical ID of the desired webhook.

POST Parameters

NameTypeDescription
eventsString[]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.
project_filterProject
secret_keyStringThe value sent in the payload required by the webservice to validate the request.
target_urlStringThe URL to which the payload will be sent.

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/webhooks/1

JSON

{
"events": [
"EXECUTION_FAILED",
"EXECUTION_FINISHED"
]
}

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/webhooks/1",
"html_url": "https://app.buddy.works/buddy/webhook/1",
"id": 1,
"target_url": "http://localhost",
"secret_key": "mysecretkey",
"project_filter": {
"url": "https://api.buddy.works/projects/company-website",
"html_url": "https://app.buddy.works/buddy/company-website",
"name": "company-website",
"display_name": "Company Website",
"status": "ACTIVE"
},
"events": [
"EXECUTION_FINISHED",
"EXECUTION_FAILED"
],
"requests": []
}