Skip to main content

Add webhook

POST 
/webhook/add

Adds a webhook for the current company (the impersonated user's company when impersonating) that sends changes to its entity records to url. add, update and remove choose which changes are sent. statusIds is only allowed for Account webhooks. An Account webhook with no workflowId gets every account, in any workflow or none, narrowed only by the statusIds, workflowStageIds and workflowActionIds it sets. With a workflowId, it gets accounts in that workflow (narrowed by workflowStageIds and workflowActionIds) and accounts in no workflow (narrowed by statusIds). Requires the webhook:manage permission in the webhook's company (the current company for add and list). Webhooks with entity Company can only be added or changed by Terros staff. url must use HTTPS, and must not point at an internal host name (such as localhost or a .local or .internal name) or at a private, loopback or link-local IPv4 or IPv6 address, checked when the webhook is added or changed. headers are stored with the webhook but never returned by any webhook endpoint, because they can hold the receiver's credentials. Webhook deliveries do not currently send them. A new webhook can take up to 5 minutes to start receiving deliveries.

Request​

Responses​

Success