Skip to navigation
API ReferenceWebhooks

Event: delivered

View as Markdown

Triggered when the provider confirms successful delivery to the recipient’s device. Emitted for SMS and WhatsApp; the email channel emits no webhooks.

The data shape is identical on both channels - message_uuid, msisdn, status, broadcast_uuid - so one handler parses either. channel (and the X-Teekrr-Channel header) tells you which channel produced the event.

Headers Teekrr sends

HeaderValue
Content-Typeapplication/json
X-Teekrr-Signaturet=<unix seconds>,v1=<HMAC-SHA256 hex>
X-Teekrr-Eventdelivered
X-Teekrr-Channelsms | 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. Any 2xx counts as success.