Callback: URL Click

Callback payload structure for WhatsApp URL click tracking events, including browser, device, campaign, link, and recipient metadata.

When an end user clicks a tracked URL in a WhatsApp message, the OneXtel platform posts a URL Click callback to your configured endpoint. Unlike the other callback event types, this payload is a flat JSON object.

The sample below shows a placeholder for each field’s value rather than example data. All fields are typed as string.

Payload format

{
  "to_number": "to_number",
  "bot_id": "bot_id",
  "repush_count": "repush_count",
  "waba_id": "waba_id",
  "template_name": "template_name",
  "browser": "browser",
  "track_location": "track_location",
  "ip": "ip",
  "msg_type": "msg_type",
  "custref1": "cust_param_1",
  "custref2": "cust_param_2",
  "operator": "operator",
  "custref3": "cust_param_3",
  "short_url": "short_url",
  "source": "source",
  "is_mmlite": "is_mmlite",
  "clicked_time": "clicked_time",
  "channel": "channel",
  "onex_received_ts": "onex_received_ts",
  "template_category": "template_category",
  "provider_id": "provider_id",
  "circle": "circle",
  "tuc_id": "tuc_id",
  "custref4": "cust_param_4",
  "retry_count": "retry_count",
  "api_key": "api_key",
  "os": "os",
  "uuid": "uuid",
  "campaign_name": "campaign_name",
  "request_time": "request_time",
  "sender_profile": "sender_profile",
  "custref5": "cust_param_5",
  "template_type": "template_type",
  "onex_msg_id": "onex_msg_id",
  "phone_number": "phone_number",
  "billing_category": "billing_category",
  "long_url": "long_url",
  "country_name": "country_name",
  "tenant_id": "tenant_id",
  "campaign_instance_id": "campaign_instance_id"
}

Field reference

Link and click details

short_url · string

The shortened tracked URL that the user clicked.

long_url · string

The full destination URL behind the short URL.

clicked_time · string

Time at which the URL was clicked.

browser · string

Browser used by the recipient when clicking the URL.

os · string

Operating system of the device used to click the URL.

ip · string

IP address from which the click originated.

track_location · string

Location tracking value for the click.

country_name · string

Country associated with the click or recipient.

circle · string

Telecom circle (regional zone) of the recipient’s number.

operator · string

Mobile operator of the recipient’s number.

Message and recipient details

to_number · string

Number the original message was sent to.

phone_number · string

Phone number field. Use to_number for the number the original message was sent to.

msg_type · string

Type of the original message.

channel · string

Messaging channel of the original message.

onex_msg_id · string

OneXtel platform message identifier of the original message.

uuid · string

Unique identifier of the event or message.

request_time · string

Time of the original send request.

onex_received_ts · string

Timestamp at which the OneXtel platform received the event.

is_mmlite · string

MM Lite flag for the message.

Template and campaign details

template_name · string

Name of the WhatsApp template used in the original message.

template_type · string

Type of the template.

template_category · string

Category of the template.

billing_category · string

Billing category applied to the message.

campaign_name · string

Name of the campaign the message belongs to.

campaign_instance_id · string

Identifier of the specific campaign run or instance.

Account and sender details

waba_id · string

WhatsApp Business Account ID.

bot_id · string

Identifier of the bot or sender configuration used.

sender_profile · string

Sender profile the message was sent from.

api_key · string

API key associated with the account that sent the message.

tenant_id · string

Tenant identifier on the OneXtel platform.

provider_id · string

Identifier of the provider.

source · string

Source of the event or message.

tuc_id · string

Identifier field. Treat the value as an opaque identifier.

Delivery mechanics

repush_count · string

Number of times the callback has been re-pushed to your endpoint.

retry_count · string

Number of retries.

Custom references

custref1–custref5 carry the custom parameters you supply with the original send request. See custom reference passthrough.

custref1 · string

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

custref2 · string

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

custref3 · string

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

custref4 · string

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

custref5 · string

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