Clicked Event
Clicked Event callbacks are triggered to notify your application that a tracked URL has been clicked. The callback contains information about the phone triggering the event and the URL clicked.
Clicked Webhook Payload
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
type | string | true | Always CLICKED | CLICKED |
direction | string | true | Always Outbound | Outbound |
channel | string | true | Always rcs | rcs |
message_id | string | true | ID of message | 4de1d075-2a7e-404e-abac-3f80560db42f |
to | string | false | The phone number the message was sent to (E164 format with no plus) | 1234567890 |
from | string | false | The sender the message was sent from | exampleSender |
tag | string | false | Custom defined string sent with message | example tag |
bulk_tag | string | false | Custom defined string sent with message | example bulk tag |
event_meta | object | true | Event specific metadata | { "url": "https://example.com" } |
event_meta.url | string | true | The URL clicked | https://example.com |
error | object | true | The message error, if applicable | { "code": "0", "description": "None" } |
error.code | string | true | Detailed error code | 0 |
error.description | string | true | Detailed error description | no error |
time | string | true | The time of the event was received in ISO 8601 format | 2025-12-08T15:30:00Z |
api_version | string | true | The version of the API the message was sent on | 1 |