Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Webhook

Create webhook

Requires one of the following scopes: webhooks:create, webhooks:all, all:create, all:all

post/api/v2/webhooks

Request body

campaignstring uuid nullable

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

namestring nullable

Optional user-defined name for the webhook

target_hook_urlstring uri required

Target URL to send webhook payloads

event_type'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' nullable

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

custom_interest_valuenumber nullable

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

headersobject nullable

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

Example request

{
  "campaign": "019f94cd-77fd-74f3-ac4a-dd8150594714",
  "name": "Zapier Positive Replies",
  "target_hook_url": "https://webhook.site/unique-url",
  "event_type": "email_sent",
  "custom_interest_value": 1,
  "headers": {
    "Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
  }
}

Response

The Webhook

idstring uuid required

Unique identifier for the webhook (UUID)

organizationstring uuid required

Organization (workspace) UUID that owns this webhook

campaignstring uuid nullable

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

namestring nullable

Optional user-defined name for the webhook

target_hook_urlstring uri required

Target URL to send webhook payloads

event_type'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' nullable

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

custom_interest_valuenumber nullable

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

headersobject nullable

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

timestamp_createdstring date-time required

Timestamp when the webhook was created

statusnumber nullable

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

timestamp_errorstring date-time nullable

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

Example response

{
  "id": "019f94cd-77fd-74f3-ac4a-dd7f7d7b5be6",
  "organization": "019f94cd-77fd-74f3-ac4a-dd8009edca34",
  "campaign": "019f94cd-77fd-74f3-ac4a-dd8150594714",
  "name": "Zapier Positive Replies",
  "target_hook_url": "https://webhook.site/unique-url",
  "event_type": "email_sent",
  "custom_interest_value": 1,
  "headers": {
    "Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
  },
  "timestamp_created": "2026-07-24T15:45:21.405Z",
  "status": 1,
  "timestamp_error": "2026-07-24T15:45:21.405Z"
}