Callback: Button Clicks

When an end user taps a button in a WhatsApp message, the OneXtel platform posts a Button Click callback to your configured endpoint. Button clicks are inbound button interactions submitted under incoming message events, so the payload follows the same structure as Incoming Messages with a button object in place of the message content objects.

In the sample below, each field’s value shows that field’s JSON path rather than an example value. All leaf fields are typed as string.

Payload format

{
  "custref1": "custref1",
  "custref2": "custref2",
  "custref3": "custref3",
  "custref4": "custref4",
  "custref5": "custref5",
  "entry": [
    {
      "id": "entry.id",
      "changes": [
        {
          "value": {
            "messages": [
              {
                "id": "entry.changes.value.messages.id",
                "timestamp": "entry.changes.value.messages.timestamp",
                "type": "entry.changes.value.messages.type",
                "context": {
                  "id": "entry.changes.value.messages.context.id",
                  "from": "entry.changes.value.messages.context.from"
                },
                "from": "entry.changes.value.messages.from",
                "button": {
                  "text": "entry.changes.value.messages.button.text",
                  "payload": "entry.changes.value.messages.button.payload"
                }
              }
            ],
            "metadata": {
              "display_phone_number": "entry.changes.value.metadata.display_phone_number",
              "phone_number_id": "entry.changes.value.metadata.phone_number_id"
            },
            "messaging_product": "entry.changes.value.messaging_product",
            "contacts": [
              {
                "profile": {
                  "name": "entry.changes.value.contacts.profile.name"
                },
                "wa_id": "entry.changes.value.contacts.wa_id"
              }
            ]
          },
          "field": "entry.changes.field"
        }
      ]
    }
  ]
}

Field reference

string

Custom reference field 1, echoed back from the original send request. See custom reference passthrough.

string

Custom reference field 2, echoed back from the original send request.

string

Custom reference field 3, echoed back from the original send request.

string

Custom reference field 4, echoed back from the original send request.

string

Custom reference field 5, echoed back from the original send request.

array of object

Container array for the callback event.

Show entry[] properties

string

Identifier of the entry.

array of object

Array of change events within this entry.

Show changes[] properties

object

The event data for this change.

Show value properties

array of object

Inbound message objects carrying the button interaction.

Show messages[] properties

string

Identifier of the inbound message.

string

Timestamp of the button click message.

string

Type of the inbound message.

string

Sender of the inbound message.

object

Context referencing the message that contained the button.

Show context properties

string

Identifier of the referenced message.

string

Sender of the referenced message.

object

Details of the button the user tapped.

Show button properties

string

Display text of the button that was clicked.

string

Payload configured for the button.

object

Metadata about the business number that received the interaction.

Show metadata properties

string

Display phone number of the business.

string

Phone number identifier of the business.

string

Messaging product for the event.

array of object

Contact details of the user who clicked the button.

Show contacts[] properties

object

Contact profile information.

Show profile properties

string

Profile name of the contact.

string

WhatsApp ID of the contact.

string

Field name describing the change.

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

Callback: Button Clicks

Payload format

Field reference

​Payload format

​Field reference

Payload format

Field reference