Webhook Events

WhatsApp number action required event

Fired when the regulator asks for more information on an already-placed regulated number order. The number stays pending (nothing was rejected); the customer can provide the missing information from the dashboard, or via the remediation endpoint. reason carries the regulator's request verbatim when available. requirements lists every requirement on the order with the reviewer's current verdict; the declined ones are what to fix, keyed by the same requirementId the remediation endpoint uses. Verdicts only change when a reviewer acts, so they describe the review at reviewedAt, the time of the reviewer's last comment.

postWebhookwhatsapp.number.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'whatsapp.number.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.

reasonstring

reviewedAtstring date-time

When the reviewer last commented on the order. Omitted when there is no reviewer comment.

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.