Skip to main content

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

ParameterTypeRequiredDescriptionExample
typestringtrueAlways CLICKEDCLICKED
directionstringtrueAlways OutboundOutbound
channelstringtrueAlways rcsrcs
message_idstringtrueID of message4de1d075-2a7e-404e-abac-3f80560db42f
tostringfalseThe phone number the message was sent to (E164 format with no plus)1234567890
fromstringfalseThe sender the message was sent fromexampleSender
tagstringfalseCustom defined string sent with messageexample tag
bulk_tagstringfalseCustom defined string sent with messageexample bulk tag
event_metaobjecttrueEvent specific metadata{ "url": "https://example.com" }
event_meta.urlstringtrueThe URL clickedhttps://example.com
errorobjecttrueThe message error, if applicable{ "code": "0", "description": "None" }
error.codestringtrueDetailed error code0
error.descriptionstringtrueDetailed error descriptionno error
timestringtrueThe time of the event was received in ISO 8601 format2025-12-08T15:30:00Z
api_versionstringtrueThe version of the API the message was sent on1