The sample below shows a placeholder for each field’s value rather than example data.
All fields are typed as
string.Payload format
Field reference
Link and click details
string
The shortened tracked URL that the user clicked.
string
The full destination URL behind the short URL.
string
Time at which the URL was clicked.
string
Browser used by the recipient when clicking the URL.
string
Operating system of the device used to click the URL.
string
IP address from which the click originated.
string
Location tracking value for the click.
string
Country associated with the click or recipient.
string
Telecom circle (regional zone) of the recipient’s number.
string
Mobile operator of the recipient’s number.
Message and recipient details
string
Number the original message was sent to.
string
Phone number field. Use
to_number for the number the original message was sent to.string
Type of the original message.
string
Messaging channel of the original message.
string
OneXtel platform message identifier of the original message.
string
Unique identifier of the event or message.
string
Time of the original send request.
string
Timestamp at which the OneXtel platform received the event.
string
MM Lite flag for the message.
Template and campaign details
string
Name of the WhatsApp template used in the original message.
string
Type of the template.
string
Category of the template.
string
Billing category applied to the message.
string
Name of the campaign the message belongs to.
string
Identifier of the specific campaign run or instance.
Account and sender details
string
WhatsApp Business Account ID.
string
Identifier of the bot or sender configuration used.
string
Sender profile the message was sent from.
string
API key associated with the account that sent the message.
string
Tenant identifier on the OneXtel platform.
string
Identifier of the provider.
string
Source of the event or message.
string
Identifier field. Treat the value as an opaque identifier.
Delivery mechanics
string
Number of times the callback has been re-pushed to your endpoint.
string
Number of retries.
Custom references
custref1–custref5 carry the custom parameters you supply with the original send
request. See
custom reference passthrough.
string
Custom reference field 1, echoed back from the original send request.
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.