Sign in

The link.followed event is delivered when a contact first follows a shortened link that was included in a message sent from a Surge number. This event is only triggered on the first click of each link; subsequent clicks on the same link do not generate additional events.

postWebhooklinkFollowed

Payload

account_idstring required

The ID of the account in which this event occurred

timestampstring date-time required

The timestamp when this event occurred, in ISO8601 format

type'link.followed' required

The type of the event. Always link.followed for this event.

Example payload

{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "id": "lnk_01kedctzhxexdbr5xf2bht5q84",
    "message_id": "msg_01jjnn7s0zfx5tdcsxjfy93et2",
    "url": "https://yoursite.com/something?param=true"
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "link.followed"
}

Response

Return a 200 status to indicate that the data was received successfully

Changes