Webhook Payload Reference

Webhook Payload Reference

Canonical Request Shape

{
  "caller_phone": "+15551234567",
  "caller_name": "John Smith",
  "caller_email": "john@example.com",
  "service_type": "HVAC Repair",
  "preferred_date": "2026-03-15",
  "preferred_time": "morning",
  "address": "123 Main St, Atlanta, GA 30301",
  "urgency": "routine",
  "notes": "AC unit making grinding noise, 2nd floor unit",
  "voice_platform": "vapi",
  "call_id": "call_abc123"
}

Field Reference

Field	Required	Type	Notes
caller_phone	Yes	string	E.164 recommended (+15551234567)
service_type	Yes	string	Requested service category
preferred_date	Yes	string	ISO date (YYYY-MM-DD)
preferred_time	No	string	Window like morning, afternoon, or exact time
caller_name	No	string	Customer full name
caller_email	No	string	Customer email
address	No	string	Service location
urgency	No	enum	routine, urgent, emergency
notes	No	string	Free-form dispatch notes
voice_platform	No	string	ghl, vapi, bland, retell
call_id	No	string	Idempotency identifier for duplicate protection

Success Response

{
  "status": "dispatched",
  "dispatch_id": "dsp_xyz789",
  "job": {
    "id": "job_123",
    "scheduled_date": "2026-03-15",
    "scheduled_time": "09:00",
    "technician": "Mike Rodriguez",
    "service_type": "HVAC Repair"
  },
  "customer": {
    "id": "cust_456",
    "name": "John Smith",
    "is_new": false
  }
}

Actual provider payloads differ. Refer to platform pages for source-specific examples.