Webhook Events

Caller identity action required event

A Branded Calling caller identity is waiting on you; reason says what.

When it fires

Every action_required is paired with a status_updated.

Reasons

  • changes_requested: answer the review with PATCH.
  • email_code: confirm the code the carrier emailed the authorizer.
  • rejected: fix and PATCH.
  • expired: resubmit.

Infringement claim

infringement_claim: a third party filed a trademark or impersonation claim and the carrier suspended the identity. Calls show a plain number and the monthly fee pauses until it is resolved.

Reply to our email with evidence that the name and logo are yours. If the claim is upheld, the identity is rejected for good.

postWebhookbranded_calling.identity.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'branded_calling.identity.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' | 'email_code' | 'rejected' | 'infringement_claim' | 'expired'
messagestring

What to do, in words.

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.