What are Webhooks?
Webhooks allow you to receive real-time notifications when specific events occur in your WaLead workspace. Instead of polling the API repeatedly, webhooks push data to your application automatically when events happen.How Webhooks Work
- Subscribe to a webhook by providing a URL endpoint and event type
- Receive POST requests at your URL when the event occurs
- Unsubscribe when you no longer need notifications
Available Webhook Types
WaLead supports the following webhook event types:Lead Events
lead_tagged_interested
Triggered when a lead is tagged as “Interested”
lead_meeting_booked
Triggered when a lead is tagged as “Meeting Booked”
lead_status_matched
Triggered when a lead is accepted by screening
lead_status_discarded
Triggered when a lead is discarded by screening
message_received
Triggered when a lead sends a message
connection_request_accepted
Triggered when a lead accepts your connection request
Campaign Events
campaign_completed
Triggered when a campaign completes
campaign_without_leads
Triggered when an active campaign runs out of leads
Account Events
linkedin_account_disconnected
Triggered when a LinkedIn account is disconnected
Webhook Payload
Each webhook POST request includes a JSON payload with event data. The structure varies by event type but generally includes:- Lead information (firstName, lastName, email, phone, companyName, linkedinUrl)
- Campaign details (campaignId, campaignName)
- Event-specific data (tags, screening decisions, messages, etc.)
Authentication
Webhooks use the samex-api-key authentication as other API endpoints. Include your API key in the header when subscribing or unsubscribing from webhooks.