Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.buildwithchirp.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks let your application receive real-time HTTP POST notifications whenever something happens in Chirp — an inbound message, a status update, a template approval, a phone-number quality change, a call ending, and many more.

​
Per-application configuration

Each application has its own webhook configuration:
  • Different webhook URLs per application
  • Independent event subscriptions per application
  • Isolated delivery and retry logic

​
Available events

Chirp emits webhooks across every channel and resource type. The full catalog with payload schemas, trigger conditions, and delivery cadence lives in Webhook Event Reference. At a glance:
  • SMS messages — inbound, sent, delivered, failed
  • WhatsApp messages — received, sent, delivered, read, failed (incl. enriched failure details)
  • WhatsApp templates — created, updated, deleted, connected
  • WhatsApp contacts — created, updated, deleted, preferences updated, CTWA conversion events
  • WhatsApp groups — created, deleted, suspended, participants added/removed/left, join requests, settings updated
  • WhatsApp account & WABA — connected, disconnected, alerts, policy reviews, capability changes
  • WhatsApp phone numbers — name updated, quality changed, security events, deregistered
  • Partner & payment — partner solutions, payment configurations
  • Calling — initiated, ringing, answered, completed, failed, no_answer, participant join/leave, recording completed, voicemail received

Full event reference

Browse every event type with full payload schemas and example bodies.

​
Webhook configuration

When creating a webhook, you specify: URL — the publicly accessible HTTPS endpoint where payloads are delivered. Events — the array of event types you want to subscribe to. Subscribe only to what you need; new events are opt-in. Headers (optional) — custom HTTP headers added to each request, useful for authenticating the request as coming from Chirp or routing to specific handlers.

​
Channel-specific setup guides

For end-to-end setup instructions and channel-specific examples: