Skip to main content

Webhook events

Webhook event payloads follow the schema below.
{
  // Base fields (always present)
  "timestamp": "string",       // ISO timestamp when the event occurred
  "event_type": "string",      // Type of event (see event types below)
  "workspace": "string",       // UUID of the workspace
  "campaign_id": "string",     // UUID of the campaign
  "campaign_name": "string",   // Name of the campaign

  // Optional fields
  "lead_email": "string",      // Email address of the lead (if the event is for a lead)
  "email_account": "string",   // Email account used to send the message (if applicable)
  "unibox_url": "string",      // URL to view the conversation in Unibox (only for reply events)

  // Step information (if available)
  "step": 1,                   // Step number in the campaign (starting at 1)
  "variant": 1,                // Variant number of the step (starting at 1)
  "is_first": true,            // Whether this is the first event of this type for the lead

  // Email information (for sent emails)
  "email_id": "string",        // The ID of the email (reply_to_uuid). You can use it to reply via the reply endpoint.
  "email_subject": "string",
  "email_text": "string",
  "email_html": "string",

  // Reply information (for reply events)
  "reply_text_snippet": "string", // Short preview of the reply content
  "reply_subject": "string",      // Subject of the reply email
  "reply_text": "string",         // Full plain-text content of the reply
  "reply_html": "string"          // Full HTML content of the reply

  // Lead data (merged from database if available)
  // Additional lead data fields from your database may appear as extra keys.
}

Event types

Email events

Event typeDescription
email_sentAn email was sent
email_openedA lead opened an email
reply_receivedA reply was received from a lead
auto_reply_receivedAn auto-reply was received
link_clickedA lead clicked a tracked link
email_bouncedAn email bounced
lead_unsubscribedA lead unsubscribed
account_errorAn account-level error occurred
campaign_completedA campaign completed

Lead status events

Event typeDescription
lead_neutralLead marked as neutral
lead_interestedLead marked as interested
lead_not_interestedLead marked as not interested

Meeting events

Event typeDescription
lead_meeting_bookedA meeting was booked
lead_meeting_completedA meeting was completed

Other lead events

Event typeDescription
lead_closedLead marked as closed
lead_out_of_officeLead is out of office
lead_wrong_personLead marked as wrong person

Custom labels

Any custom label configured in your workspace will be sent as the event_type value as-is.