link.* events
Smart Link lifecycle.
Smart Link lifecycle. Fires as a creator authors, changes and retires the named, tracked addresses that bring members into a project. A Smart Link is one address per channel (a video description, a bio, a newsletter, a flyer's QR) whose clicks, and the members, purchases and payments behind them, are counted apart from every other channel's. Clicks and attributions carry no event of their own: a click is too frequent and too anonymous to be worth a webhook, and a member's source rides on the member wherever the member is read.
All three describe the link itself and are driven by the creator. The figures a link has earned are read from the funnel endpoints, never pushed.
Background
Every event nests a link snapshot
created, updated and archived all carry the same nested object under data.link, so one consumer can handle all three:
{
"link": {
"id": "7c2e5a90-3f41-4b8d-9e62-1a0d4c8b7f35",
"name": "YouTube description",
"slug": "youtube",
"code": "K7PMQ2X",
"destination": "plan",
"plan_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
"url": "https://my.subscriby.net/jane/go/youtube",
"expires_at": null,
"archived_at": null,
"clicks_total": 0
}
}The slug may change; the code never does.
urlis built from the slug and is the address a person reads.codeis what the attribution cookie and the bot'svia_start payload carry, so a printed QR or a shared bot link keeps working after the creator renames the address. Store the id, display the url, and never derive one from the other.
Destinations
destination is one of portal (the project's plan list), plan (the checkout of the plan in plan_id) or bot (a conversation with the project's bot). plan_id is set only on a plan destination. A plan destination whose plan is later deleted, and a bot destination on a project with no bot, both land on the portal home rather than on an error page, so a printed link never breaks.
Required ability
Every event in this family requires project-link:view at token mint time.
Events
link.createdA new Smart Link was authored in a project.link.updatedA Smart Link's name, address, destination or expiry changed.link.archivedA Smart Link was put out of use.Related
How is this guide?
Last updated on