Occurs whenever a link is clicked (or when its QR code is scanned).
You can scope which links trigger a link.clicked webhook. When creating or editing the webhook in the dashboard, choose one of the following:
- All links – trigger the webhook for every link in your workspace.
- Include specific folders (recommended) – trigger the webhook for all links in the selected folders.
- Include specific links – trigger the webhook only for the links you explicitly select.
If you select the 3rd option, you can programmatically associate specific links with your link.clicked webhook by passing the webhook ID under the webhookIds prop when creating or updating a link.
Response body parameters
All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.
link.clicked).link.clicked event contains the following parameters:Show object parametersHide object parameters
Details about the click event.
Show click objectHide click object
Unique identifier for the click.
ISO 8601 timestamp when the click occurred.
The destination URL that was visited.
Country code (e.g. US).
City name.
Region or region code.
Continent code (e.g. NA).
Device type (e.g. Desktop, Mobile).
Browser name (e.g. Chrome).
Operating system (e.g. Mac OS).
User agent string.
Referrer hostname or (direct).
Full referrer URL or (direct).
Whether the click came from a QR code scan.
IP address of the visitor.
The link resource that was clicked (full link object including stats such as clicks, shortLink, url, etc.).