Skip to main content
POST
Register webhook

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx

Headers

Xerobi-Version
string
default:2026-01-01
required

API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.

Pattern: ^\d{4}-\d{2}-\d{2}$

Body

application/json
url
string<uri>
required

Webhook callback URL (must be HTTPS)

Example:

"https://yourapp.com/webhooks/sms"

events
enum<string>[]
required

Events to subscribe to

Minimum array length: 1
Available options:
message.queued,
message.sent,
message.delivered,
message.failed,
message.expired
Example:
description
string

Optional description for webhook

Maximum string length: 200
Example:

"Production delivery notifications"

Response

Webhook registered successfully

Webhook configuration for delivery status callbacks

id
string
required

Unique webhook identifier

Example:

"wh_001xyz"

url
string<uri>
required

Callback URL (must be HTTPS)

Example:

"https://yourapp.com/webhooks/sms"

events
enum<string>[]
required

List of events to receive

Available options:
message.queued,
message.sent,
message.delivered,
message.failed,
message.expired
Example:
enabled
boolean
required

Whether webhook is currently active

Example:

true

secret
string

Secret key for webhook signature verification

Example:

"whsec_abc123xyz456"

retry_config
object

Retry configuration for failed deliveries

last_triggered_at
string<date-time> | null

Last successful webhook delivery

Example:

"2026-01-15T10:30:00Z"

failure_count
integer

Consecutive failure count

Required range: x >= 0
Example:

0

created_at
string<date-time>

Creation timestamp

Example:

"2025-11-01T12:00:00Z"