WhatsApp Callback Events

Overview of the WhatsApp callback payload formats delivered by the OneXtel platform: incoming messages, delivery notifications, button clicks, and URL clicks.

The OneXtel platform sends callback notifications to your system for WhatsApp events. This section defines the callback payload format for each supported event type.

Contact OneXtel support to configure your callback endpoint.

Callback event types

Event type	Description
Incoming Messages	Callback payload structure for inbound WhatsApp messages, including text, media, location, and related contact metadata.
Delivery Notification	Callback payload structure for message delivery status updates, conversation details, pricing, and recipient status information.
Button Clicks	Callback payload structure for inbound button interactions submitted under incoming message events.
URL Click	Callback payload structure for URL click tracking events, including browser, device, campaign, link, and recipient metadata.

Custom reference passthrough

All four event payloads include the custref1–custref5 custom reference fields.

Every callback payload carries five custom reference fields:

{
  "custref1": "custref1",
  "custref2": "custref2",
  "custref3": "custref3",
  "custref4": "custref4",
  "custref5": "custref5"
}

These are optional custom reference fields you supply when sending a message through the OneXtel send APIs, used for tracking or tagging. The platform echoes them back unchanged in the callback, so you can correlate each callback event with your own internal identifiers (order IDs, campaign tags, user IDs, and so on).

custref1 · string

Custom reference field 1. Optional on the send request; returned as-is in callbacks.

custref2 · string

Custom reference field 2. Optional on the send request; returned as-is in callbacks.

custref3 · string

Custom reference field 3. Optional on the send request; returned as-is in callbacks.

custref4 · string

Custom reference field 4. Optional on the send request; returned as-is in callbacks.

custref5 · string

Custom reference field 5. Optional on the send request; returned as-is in callbacks.

Reading the payload formats

In the payload examples on the following pages, each field’s value shows that field’s JSON path rather than an example value, for example "id": "entry.changes.value.messages.id". All leaf fields are typed as strings.