Last updated

Webhook Events

The webhook events will 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 section 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 (available if the event is for a lead)
    email_account?: string,    // Email account used to send the message (if applicable to event type)
    unibox_url?: string,       // URL to view the conversation in Unibox (only for reply events)
    
    // Step Information (if available)
    step?: number,             // Step number in the campaign (starting at 1; available based on event type)
    variant?: number,          // Variant number of the step (starting at 1; available based on event type)
    is_first?: boolean,          // Whether this is the first event of this type for the lead

    // Email information (for sent emails)
    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)
    [key: string]: any         // Additional lead data fields from your database
}

Event Types

// Email Events
"email_sent"
"email_opened"
"reply_received"
"auto_reply_received"
"link_clicked"
"email_bounced"
"lead_unsubscribed"
"account_error"
"campaign_completed"

// Lead Status Events
"lead_neutral"
"lead_interested"
"lead_not_interested"

// Meeting Events
"lead_meeting_booked"
"lead_meeting_completed"

// Other Lead Events
"lead_closed"
"lead_out_of_office"
"lead_wrong_person"

// Custom Labels
// Any custom label configured in your workspace will be sent as-is