Events
link.followed
Fires the first time a contact clicks a shortened link in a message.
WEBHOOK
Fires the first time a contact follows a shortened link that Surge embedded in a message. Subsequent clicks on the same link by the same contact do not fire additional events.
Deprecation note: The top-level
message_id field in the payload is deprecated. Use the nested message.id field instead. message_id will be removed in a future API version.
Common use case
Uselink.followed to measure click-through rates on campaigns, trigger re-engagement sequences when a contact shows interest, or attribute web conversions back to specific messages.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The ID of the account in which this event occurred
The data associated with the event
The timestamp when this event occurred, in ISO8601 format
The type of the event. Always link.followed for this event.
Allowed value:
"link.followed"Response
200
Return a 200 status to indicate that the data was received successfully