Skip to navigation
API ReferenceWebhooks

Event: inbound

View as Markdown

Triggered when a customer sends a message to your WhatsApp number - a reply to a broadcast, or a conversation they started. WhatsApp only.

Unlike the status events, inbound is not filtered by broadcast origin: you receive replies regardless of whether the original message was sent via the API or composed in the dashboard. There is no origin to attribute, so api_key is null.

Inbound messages on the shared platform-default WhatsApp number are not attributable to a single client and do not fire this event - only clients with their own WABA receive inbound.

X-Teekrr-Event: inbound, 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

Response

2XX
Acknowledge receipt within 10 seconds.