Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

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

Webhooks let Allo push events to your server in real time. When something happens — a call finishes, an SMS arrives, a contact is created — Allo sends an HTTPS POST request to your endpoint with the event data.

How it works

  1. An event occurs in your Allo account (e.g., a call is completed).
  2. Allo sends an HTTPS POST request to the URL you configured.
  3. Your server receives the request, verifies the signature, and processes the event.

Available events

EventDescription
call.receivedInbound call starts ringing
call.triggeredOutbound call initiated
call.completedCall finished with full data (recording, transcript, summary)
tag.addedTag added to a call
tag.removedTag removed from a call
sms.receivedInbound SMS received
sms.sentOutbound SMS sent
contact.createdContact created
contact.updatedContact updated
See the Event catalog for full payload schemas.

Payload format

Every webhook uses the same envelope format:
{
  "topic": "call.completed",
  "version": "2.0",
  "timestamp": "2025-03-15T14:30:45.123456Z",
  "data": {
    // Event-specific fields
  }
}
FieldTypeDescription
topicstringEvent type (e.g., call.completed, sms.received)
versionstringPayload version, always "2.0"
timestampstringISO 8601 timestamp when the event was sent
dataobjectEvent-specific payload

Quickstart

1

Create a webhook endpoint

Go to Settings > Webhooks in your Allo dashboard. Add your HTTPS endpoint URL and select the events you want to receive. The webhook applies to all Allo numbers in your workspace.
2

Handle incoming requests

Your endpoint receives POST requests with the event payload in the body. Return a 2xx status code within 20 seconds to acknowledge receipt.
3

Verify signatures

Every webhook includes a cryptographic signature. Verify it to ensure the request came from Allo. See Verifying signatures.

Next steps

Event catalog

Full reference for all events and their payloads

Verifying signatures

Authenticate incoming webhooks with HMAC-SHA256