Webhook Events

WhatsApp number suspended event

Fired when an active number is suspended (e.g. a failed payment). The number stops working until the issue is resolved, after which a whatsapp.number.reactivated event is sent. reason carries the cause (e.g. payment_failed, subscription_ended).

postWebhookwhatsapp.number.suspended

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

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 nullable

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.