Webhook Event Types
Complete reference for all webhook event types, their payload structures, and field descriptions.
SMS Events
Notifications for SMS message lifecycle events.
message.sent
SMS Events
Message was accepted and dispatched to the carrier.
message.sent.json
1{2 "id": "evt_8f3a1b2c",3 "type": "message.sent",4 "timestamp": "2025-01-15T10:30:00.000Z",5 "payload": {6 "messageId": "msg_9x8y7z6w5v",7 "to": "+251911234567",8 "from": "MyApp",9 "status": "SENT",10 "sentAt": "2025-01-15T10:30:00.000Z"11 }12}OTP Events
Notifications for OTP generation and delivery flow.
otp.sent
OTP Events
OTP code was generated and dispatched.
otp.sent.json
1{2 "id": "evt_a1b2c3d4",3 "type": "otp.sent",4 "timestamp": "2025-01-15T10:35:00.000Z",5 "payload": {6 "messageId": "msg_otp_7h8i9j",7 "to": "+251911234567",8 "status": "SENT",9 "expiresIn": 300,10 "expiresAt": "2025-01-15T10:40:00.000Z"11 }12}Payload Field Reference
Top-Level Fields
idUnique event identifier (prefixed with evt_).typeThe event type string matching the subscription.timestampISO 8601 timestamp when the event occurred.dataObject containing event-specific details.Common Data Fields
messageIdUnique message identifier (prefixed with msg_).toRecipient phone number in E.164 format.fromSender ID or application name.statusCurrent status of the resource.errorCodeMachine-readable error code (only on failure events).errorMessageHuman-readable error description (only on failure events).