Skip to main content
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

Use link.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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
account_id
string
required

The ID of the account in which this event occurred

data
object
required

The data associated with the event

timestamp
string<date-time>
required

The timestamp when this event occurred, in ISO8601 format

type
string
required

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