Edit
Edits a webhook. Restricted to admins only.
Required scopes: WORKSPACE, WEBHOOK_MANAGE
Resource URL
PATCH /workspaces/:domain/webhooks/:webhook_idURL Parameters
| Name | String | Description |
|---|---|---|
domain Required | String | The workspace domain. |
webhook_id Required | Integer | The numerical ID of the desired webhook. |
POST Parameters
| Name | Type | Description |
|---|---|---|
| events | 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. |
| projects | String[] | The array of project name IDs from which webhooks will be executed. |
| secret_key | String | The value sent in the payload required by the webservice to validate the request. |
| target_url | String | The URL to which the payload will be sent. |
Example
Request
PATCH https://api.buddy.works/workspaces/buddy/webhooks/1JSON
{
"events": [
"EXECUTION_FAILED",
"EXECUTION_FINISHED"
]
}Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999JSON
{
"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",
"projects": ["company-website", "beta-project"],
"events": [
"EXECUTION_FINISHED",
"EXECUTION_FAILED"
],
"requests": []
}Last modified on April 26, 2022