Webhook Events

Message played event

Fires the first time the recipient plays a voice message you sent on WhatsApp.

postWebhookmessage.played

Payload

idstring required

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'message.delivered' | 'message.read' | 'message.played' | 'message.failed' required
statusAtstring date-time required

When the platform reported this status.

timestampstring date-time required

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.

Example payload

{
  "pricing": {
    "pricingModel": "PMP",
    "category": "marketing",
    "type": "regular"
  },
  "billingConversation": {
    "originType": "utility"
  }
}

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.