Skip to navigation
API ReferenceWebhooks

Event: read

View as Markdown

Triggered when the recipient opens the message. WhatsApp only, and only when the recipient has read receipts enabled.

X-Teekrr-Event: read, X-Teekrr-Channel: whatsapp.

Payload

The payload of this webhook request is an object.
eventenumRequired
Allowed values:
channelenumRequired
Allowed values:
api_keyobjectRequired

The API key whose broadcast produced this event, so a consumer whose several keys point at one endpoint can tell them apart. null for a dashboard-composed send or an unattributable message.

timestampdatetimeRequired

When Teekrr built the payload (ISO 8601, UTC).

dataobjectRequired

Payload shape for sent / delivered / read / failed. Identical on every channel - one handler parses both SMS and WhatsApp. SMS emits only delivered and failed; sent and read are WhatsApp-only.

Response

2XX
Acknowledge receipt within 10 seconds.