Register Webhook
Register a new webhook endpoint to receive delivery status updates.
Security:
- Webhooks are signed with HMAC-SHA256
- Verify signature using
X-Xerobi-Signatureheader - Secret is provided in the response
Retry Logic:
- Failed deliveries are retried with exponential backoff
- Maximum 3 retry attempts
- Webhook disabled after 10 consecutive failures
Payload Example:
Authorizations
Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx
Headers
API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.
^\d{4}-\d{2}-\d{2}$Body
Webhook callback URL (must be HTTPS)
"https://yourapp.com/webhooks/sms"
Events to subscribe to
1message.queued, message.sent, message.delivered, message.failed, message.expired Optional description for webhook
200"Production delivery notifications"
Response
Webhook registered successfully
Webhook configuration for delivery status callbacks
Unique webhook identifier
"wh_001xyz"
Callback URL (must be HTTPS)
"https://yourapp.com/webhooks/sms"
List of events to receive
message.queued, message.sent, message.delivered, message.failed, message.expired Whether webhook is currently active
true
Secret key for webhook signature verification
"whsec_abc123xyz456"
Retry configuration for failed deliveries
Last successful webhook delivery
"2026-01-15T10:30:00Z"
Consecutive failure count
x >= 00
Creation timestamp
"2025-11-01T12:00:00Z"