Webhook Events

SMS registration action required event

An SMS registration is waiting on its owner; reason says why.

Reasons

  • changes_requested: answer message via POST /v1/sms/registrations/{id}/respond.
  • otp_required: submit the texted code via POST /v1/sms/registrations/{id}/verify-otp; no message.
  • carrier_info_required: expires after 7 days.

When it fires

Fires once per new request and once per OTP or carrier request, not on follow-up messages. A carrier rejection alone does not fire it.

postWebhooksms.registration.action_required

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.action_required'
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.

reason'changes_requested' | 'otp_required' | 'carrier_info_required'
messagestring

What to do, in words: our request or the carrier's note. Absent for otp_required.

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.