Update a webhook
Webhooks
Update a webhook
Updates a webhook. Only fields included in the body are modified.
Required scope
Required scope
webhooks:manage
PATCH
Update a webhook
Authorizations
OAuth 2.1 access token.
Path Parameters
Webhook ID.
Body
application/json
New descriptive name.
Required string length:
1 - 100Example:
"Updated webhook name"
New HTTPS destination URL.
Example:
"https://myapp.com/webhooks/vendaze-v2"
New list of subscribed events. Replaces the existing list entirely.
Minimum array length:
1A valid webhook event name.
Available options:
person.created, person.updated, person.deleted, activity.created, activity.updated, activity.deleted, company.created, company.updated, company.deleted, deal.created, deal.updated, deal.stage_changed, deal.won, deal.lost, deal.deleted, task.created, task.updated, task.completed, task.deleted, tag.created, tag.updated, tag.deleted, product.created, product.updated, product.deleted, pipeline.created, pipeline.updated, pipeline.deleted, member_invited, member_joined, member_removed, usage_logs.created Example:
[
"person.created",
"person.updated",
"deal.won",
"deal.lost"
]false to true: generates a new webhook_secret. true to false: permanently deletes the existing webhook_secret. No change: webhook_secret is not modified.
Example:
false
Response
Webhook updated successfully.