Skip to main content
This schema describes objects returned by the Webhook endpoints.

A webhook subscription for receiving event notifications

​
id
string<uuid>
required
read-only

Unique identifier for the webhook (UUID)

Example:

"01a118d4-3a98-7390-9878-28d315a03acb"

​
organization
string<uuid>
required
read-only

Organization (workspace) UUID that owns this webhook

Example:

"01a118d4-3a99-7272-83f9-6ab824a08d5a"

​
target_hook_url
string<uri>
required

Target URL to send webhook payloads

Pattern: ^https?://
Example:

"https://webhook.site/unique-url"

​
timestamp_created
string<date-time>
required
read-only

Timestamp when the webhook was created

Example:

"2026-10-08T00:05:24.249Z"

​
campaign
null | string<uuid>

Optional campaign UUID to filter events (null = all campaigns in workspace)

Example:

"01a118d4-3a99-7272-83f9-6ab9c149fc00"

​
name
null | string

Optional user-defined name for the webhook

Example:

"Zapier Positive Replies"

​
event_type
null | enum<string>

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

Available options:
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
Example:

"email_sent"

​
custom_interest_value
null | number

Custom interest value - corresponds to LeadLabel.interest_status (used for custom label events)

Example:

1

​
headers
null | object

Optional HTTP headers to include when delivering webhook payloads (key-value pairs)

Example:
​
status
null | number

Webhook status: 1 = active, -1 = error (disabled due to delivery failures)

Example:

1

​
timestamp_error
null | string<date-time>

Timestamp when webhook was disabled due to delivery failures (null if active)

Example:

"2026-10-08T00:05:24.249Z"