This schema describes objects returned by the Webhook endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the webhook (UUID) (read-only) |
organization | string (uuid) | Yes | Organization (workspace) UUID that owns this webhook (read-only) |
campaign | string (uuid), nullable | No | Optional campaign UUID to filter events (null = all campaigns in workspace) |
name | string, nullable | No | Optional user-defined name for the webhook |
target_hook_url | string (uri) | Yes | Target URL to send webhook payloads |
event_type | string, nullable | No | Type of event to trigger the webhook (null for custom label events). Set to “all_events” to subscribe to all events - including custom label events. Possible values: all_events, email_sent, email_opened, email_link_clicked, reply_received, email_bounced, lead_unsubscribed, campaign_completed, account_error, lead_neutral, lead_interested, lead_not_interested, lead_meeting_booked, lead_meeting_completed, lead_closed, lead_out_of_office, lead_wrong_person, lead_no_show, supersearch_enrichment_completed |
custom_interest_value | number, nullable | No | Custom interest value - corresponds to LeadLabel.interest_status (used for custom label events) |
headers | object, nullable | No | Optional HTTP headers to include when delivering webhook payloads (key-value pairs) |
timestamp_created | string (date-time) | Yes | Timestamp when the webhook was created (read-only) |
status | number, nullable | No | Webhook status: 1 = active, -1 = error (disabled due to delivery failures) (read-only) |
timestamp_error | string (date-time), nullable | No | Timestamp when webhook was disabled due to delivery failures (null if active) (read-only) |