Skip to Content
DocsWebhooksOverview

Webhooks Overview

Webhooks are the primary way to send leads to Lead Warmer. When your CRM or lead source detects a new lead, it sends a webhook to Lead Warmer, which triggers the video generation process.

How It Works

Your CRM → Webhook → Lead Warmer → Video Generation → Email Delivery
  1. Lead Created: Your system detects a new lead
  2. Webhook Sent: Your system sends lead data to Lead Warmer
  3. Lead Processing: Lead Warmer validates and processes the data
  4. Campaign Matching: Lead is matched against active campaigns
  5. Video Generation: AI generates a personalized video
  6. Email Delivery: Video is sent to the lead

Your Webhook Endpoint

Each organization has a unique webhook URL:

https://api.leadwarmer.net/webhooks/ingest/{webhook-id}

Find your webhook URL in Settings > Webhooks.

Supported Methods

MethodDescription
POSTSend new leads (primary method)
GETHealth check (returns 200 OK)

Response Codes

CodeDescription
202Lead accepted for processing
400Invalid payload format
401Invalid or missing signature
429Rate limit exceeded
500Internal server error

Success Response

{ "success": true, "lead_id": "lead-uuid-here", "message": "Lead accepted for processing" }

Error Response

{ "success": false, "error": "Invalid payload: missing required field 'email'", "code": "INVALID_PAYLOAD" }

Rate Limits

  • Default: 100 requests per minute
  • Enterprise: 1000 requests per minute
  • Rate limit headers included in responses

Next Steps