Be notified when a shortlink has been clicked
Event
| Event Name | Description |
|---|---|
| Clicked | Triggered 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
| Parameter | Show/Hide | Description |
|---|---|---|
| type | Always shown | Specifies the event type. |
| source | Always shown | Indicates the event's origin, such as the API URL.. |
| id | Always shown | Unique webhook event identifier. |
| time | Always shown | Timestamp (ISO 8601 format) of the event. |
| datacontenttype | Always shown | Specifies the data format, typically "application/json". |
| → status | Always shown | SMS message status (submitted, delivered, failed, clicked). |
| → channel | Always shown | Specifies channel used to send the message |
| →from | Always shown | Recipient phone number. |
| →short_link | Always shown | The short link that was clicked. |
| →type | Always shown | Shortlink or Attachment link. |
| →short_link_id | Always shown | The UID of the clicked shortlink. |
| →url | Shown for type Shortlink only | The original/target URL. |
| →short_link_name | Always shown | The name of the shortlink. |
| →device | Always shown | The type of device used to access the shortlink (e.g., mobile, tablet, desktop). |
| →browser | Always shown | The web browser application used to open the shortlink (e.g., Chrome, Safari, Firefox). |
| →os | Always shown | The operating system running on the user's device at the time of the click (e.g., Windows, iOS, Android). |
| tracking_id | Always shown | A unique ID for the click. |
| →campaign_id | Shown if message was sent as part of a Campaign | If the message was requested as part of a campaign then the campaign ID is provided. |