Webhook Events

Caller identity status updated event

A Branded Calling caller identity changed status.

When it fires

Fires once per transition of the identity's status, the value GET /v1/branded-calling/identities/{id} returns. Never on a re-check that found nothing new.

Statuses

requested, changes_requested, rejected (reason says why), pending_email_verification, in_review, verified (live for a year, attach numbers), suspended (infringement claim open), expired, permanently_rejected.

postWebhookbranded_calling.identity.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'branded_calling.identity.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'requested' | 'changes_requested' | 'rejected' | 'pending_email_verification' | 'in_review' | 'verified' | 'suspended' | 'expired' | 'permanently_rejected'
reasonstring

Our review note, or the carrier's rejection reasons, when there is one.

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.