Create Webhook Subscription
create_webhook_subscriptionRegister a webhook subscription that sends a POST payload to your HTTPS URL when a CRM event occurs. Reuse of an identical subscription returns the existing one instead of duplicating.
Instructions
Create Webhook Subscription.
Registers a webhook subscription. Registering an identical subscription (same hookUrl, event type, and filter) does not create a duplicate: the existing subscription is returned, and a deactivated one is reactivated.
Delivery: When the selected event happens, the application sends a POST request to hookUrl with the related payload in the request body.
Payload types:
Event Type | Payload Type |
| WebhookContactPropertyChangedPayload |
| WebhookDealPropertyChangedPayload |
| WebhookDealStageChangedPayload |
| WebhookActivityCreatedPayload |
| WebhookFormSubmittedPayload |
| WebhookContactCreatedPayload |
| WebhookDealCreatedPayload |
| WebhookActionButtonExecutedPayload |
Filters: Supported filter fields and matching behaviour depend on the selected event type.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Webhook subscription. Call `describe_webhook_event` with the event type first to get the filter schema and payload format. |