Event Types

Webhooks deliver structured JSON payloads to your endpoint via HTTP POST. This page describes the payload format and the available event categories.

Payload Structure

The following is an example payload for an inbound message event:

{
  "uuid": "webhook-event-uuid",
  "channel": "text",
  "direction": "inbound",
  "created_at": "2024-01-15T10:30:00Z",
  "from": "+15551234567",
  "to": "+15559876543",
  "content": "Message content here",
  "token": "token-identifier",
  "last_status": "delivered"
}

Field Reference

Field	Type	Description
uuid	string	Unique event identifier
channel	string	Communication channel: text, email, or voice
direction	string	inbound or outbound
created_at	string	ISO 8601 timestamp of when the event was created
from	string	Sender identifier (phone number, email address, etc.)
to	string	Recipient identifier (phone number, email address, etc.)
content	string	Message body
token	string	Token identifier associated with the event
last_status	string	Current delivery status of the message

Event Categories

Messages

Message events fire for inbound and outbound communications across all supported channels:

• Text -- SMS and MMS messages
• Email -- inbound and outbound email
• Voice -- voice call events

Events

Event notifications are triggered by scheduling and case event updates within the system.

Payments

Payment events are delivered when payment transactions are processed.

Next Steps

• Verification -- verify the authenticity of incoming payloads
• Retry Behavior -- understand how failed deliveries are retried