Subscribe to an event
target_url must be public HTTPS. Localhost, private IP addresses, and hostnames that resolve to them are rejected. The URL is checked again before each delivery. Any one of the listed scopes is enough to create a subscription.
Required scope: any of leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
Subscribe to an event › Request Body
target_urlPublic HTTPS URL that receives the event.
event_typeEvent to subscribe to.
Optional filter object stored with the subscription.
Subscribe to an event › Responses
The subscription. The target URL is not returned.
idSubscription id. Send this to DELETE /hooks/{subscriptionId}.
event_typeSubscribed event.
activetrue until the subscription is disabled.
created_atISO-8601 timestamp.
Disable a webhook subscription
Marks the subscription inactive. Deliveries stop. The response is { success: true }.
Required scope: any of leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
path Parameters
subscriptionIdSubscription id returned by POST /hooks.
Disable a webhook subscription › Responses
The subscription was disabled.
successGet a sample webhook payload
Returns an array with one sample object. eventType is form_lead.created, quiz_lead.created, page.published, page.created, product.created, funnel.created, site.created, or project.created. Unknown types return the form-lead sample.
Required scope: any of leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
path Parameters
eventTypeEvent name, for example form_lead.created.
Get a sample webhook payload › Responses
One sample event in an array.