Skip to main content
WEBHOOK

Authorizations

​
Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

​
webhook-id
string
required

The event id, the same on every retry: deduplicate on it.

​
webhook-timestamp
string
required

When this attempt was signed, in Unix seconds. Refuse old timestamps.

​
webhook-signature
string
required

Space-separated v1,<base64> HMAC-SHA256 signatures of {id}.{timestamp}.{body} under your endpoint's whsec_ secret (newest secret first during a rotation).

Body

application/json

A phone number was released.

​
id
string
required

The event id (also the webhook-id header).

​
type
string
required

The event type.

Allowed value: "number.released"
​
api_version
string
required

The payload version this event was written in.

Example:

"2026-11-01"

​
timestamp
string<date-time>
required

When it happened (UTC).

​
data
NumberData · object
required
​
test
boolean

Present and true on a test delivery.

Response

Acknowledged. Answer within 15 seconds; do the work afterwards.