CTA URL Clicked

{
  "eventType": "ctaUrlClicked",
  "localMessageId": "msg-abc-123",
  "id": "507f1f77bcf86cd799439011",
  "whatsappMessageId": "wamid.HBgL...",
  "templateId": "tpl-1a2b3c",
  "templateName": "order_confirmation",
  "created": "2026-04-24T10:00:00",
  "conversationId": "conv-xyz-789",
  "ticketId": "ticket-456",
  "displayText": "Visit us",
  "buttonUrl": "https://shop.example.com/promo",
  "text": "Your order is ready! Tap the button to continue.",
  "operatorEmail": "[email protected]",
  "waId": "1234567890",
  "type": "template",
  "statusString": "SENT",
  "sourceType": "api",
  "channelId": null,
  "channelPhoneNumber": "17435002445",
  "bsuid": "HK.xxxxxxxxxxxxx",
  "parentBsuid": "HK.ENT.xxxxxxxxxxxxx",
  "username": "@bob"
}

Field Descriptions

Field NameTypeDescription
eventTypestringEvent type identifier: "ctaUrlClicked"
localMessageIdstringLocal message identifier for tracking
idstringUnique identifier for the message
whatsappMessageIdstringWhatsApp's unique message identifier
templateIdstringUnique identifier of the template used
templateNamestringName of the template that contained the CTA button
createdstringISO 8601 timestamp when the click event was recorded
conversationIdstringUnique identifier for the conversation thread
ticketIdstringUnique identifier for the support ticket
displayTextstringThe visible text shown on the CTA button
buttonUrlstringThe URL that was clicked (resolved/tracked URL)
textstringThe text content of the template message
operatorEmailstringEmail of the operator who sent the template
waIdstringWhatsApp ID of the contact who clicked the button
typestringMessage type (always "template" for CTA clicks)
statusStringstringMessage delivery status
sourceTypestringSource of the original template message
channelIdstring/nullIdentifier for the communication channel
channelPhoneNumberstringPhone number of the WhatsApp Business account
bsuidstring/nullBusiness Solution User ID — stable cross-channel identifier. Only present when available.
parentBsuidstring/nullParent BSUID — enterprise-level identifier. Only present when available.
usernamestring/nullHuman-readable username handle. Only present when available.