Webhook Events

SMS registration status updated event

An SMS registration changed status; status is the new one.

Statuses

  • changes_requested: answers needed.
  • requested: submitted, resubmitted, or your answers are back in review.
  • pending: with the carriers.
  • approved: live, attach numbers.
  • rejected: reason is the carriers' words.
  • deactivated

Rejections

A carrier rejection needs nothing from you. Zernio handles the fix and resends it, so the status returns to pending.

postWebhooksms.registration.status_updated

Payload

testboolean

Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.

idstring

Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery. It identifies the event only, never an account or other resource.

event'sms.registration.status_updated'
timestampstring date-time

UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.

status'changes_requested' | 'requested' | 'pending' | 'approved' | 'rejected' | 'deactivated'
reasonstring

The carriers' decline reason, on rejected.

Example payload

{
  "profiles": [
    {
      "externalId": "tenant_42"
    }
  ]
}

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.