Webhooks
Create Webhook
Creates a new webhook endpoint that will receive HTTP POST requests when specified events occur. All webhook deliveries include a signature header for verification.
Endpoint
POST
/api/v1/webhooksRequest Body
| Name | Type | Description |
|---|---|---|
urlrequired | string | The URL that will receive webhook events |
eventsrequired | string[] | Array of event types to subscribe to |
description | string | Optional description for this webhook |
active | boolean | Whether the webhook is active (default: true) |
Response
Returns the created webhook object including its unique ID and secret for signature verification.
Important: The
secretis only returned when the webhook is created. Store it securely as you'll need it to verify webhook signatures.
Example
Event Types
Available events you can subscribe to:
| Event | Description |
|---|---|
lead.created | A new lead was created |
lead.updated | A lead was updated |
lead.converted | A lead was marked as converted |
campaign.started | A campaign was activated |
campaign.paused | A campaign was paused |