Shortlink Clicked

Be notified when a shortlink has been clicked

Event

Event NameDescription
ClickedTriggered when a Webex Interact generated shortlink included within the message has been clicked.

Payload Samples

//Sample response when a user clicks on a shortlink in the sent SMS
{
  "specversion": "1.0",
  "type": "com.interact.messages.sms.status",
  "source": "https://api.webexinteract.com/v1/sms",
  "id": "evt_2z01l2qQ8MRVmFZSUQHHxIjVvje",
  "time": "2025-06-25T12:08:43Z",
  "datacontenttype": "application/json",
  "data": {
    "status": "clicked",
    "channel": "sms",
    "phone_number": "+447810000001",
    "from": "Name",
    "short_link": "https://intr.cc/D0vRZp",
    "type": "LINK", 
    "url": "https://www.cisco.com/c/r/team-development/career-and-learning/learning-subscriptions.html",
    "short_link_id": "shl_30rdc2Mie8PXOG4taeBqTxlnZrH", 
    "short_link_name": "Learning link",
    "device": "PC",
    "browser": "CHROME",
    "os": "MAC_OS",
    "campaign_id": "cmp_2yzyPKOKFjbycNEYSwkjk85ceqX"
  },
  "tracking_id": "30recwEuHHhrQtggF3E5vUMkH9C"
}

Field Definitions

ParameterShow/HideDescription
typeAlways shownSpecifies the event type.
sourceAlways shownIndicates the event's origin, such as the API URL..
idAlways shownUnique webhook event identifier.
timeAlways shownTimestamp (ISO 8601 format) of the event.
datacontenttypeAlways shownSpecifies the data format, typically "application/json".
→ statusAlways shownSMS message status (submitted, delivered, failed, clicked).
→ channelAlways shownSpecifies channel used to send the message
→fromAlways shownRecipient phone number.
→short_linkAlways shownThe short link that was clicked.
→typeAlways shownShortlink or Attachment link.
→short_link_idAlways shownThe UID of the clicked shortlink.
→urlShown for type Shortlink onlyThe original/target URL.
→short_link_nameAlways shownThe name of the shortlink.
→deviceAlways shownThe type of device used to access the shortlink (e.g., mobile, tablet, desktop).
→browserAlways shownThe web browser application used to open the shortlink (e.g., Chrome, Safari, Firefox).
→osAlways shownThe operating system running on the user's device at the time of the click (e.g., Windows, iOS, Android).
tracking_idAlways shownA unique ID for the click.
→campaign_idShown if message was sent as part of a CampaignIf the message was requested as part of a campaign then the campaign ID is provided.