Skip to content

Commit 686264f

Browse files
docs: update link.clicked webhook scope options (#406)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Steven Tey <stevensteel97@gmail.com>
1 parent 2dbfcb7 commit 686264f

2 files changed

Lines changed: 13 additions & 10 deletions

File tree

docs/webhooks/event-types.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Webhooks send real-time notifications when events happen in your Dub workspace.
3636

3737
[Dub Links](https://dub.co/links) is your short link and analytics platform for creating, managing, and tracking links. Here are the webhook events that are available for Dub Links:
3838

39-
| Event Type | Description |
40-
| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
41-
| [`link.created`](/docs/webhooks/events/link-created) | Occurs when a **new link is created** in your workspace. |
42-
| [`link.updated`](/docs/webhooks/events/link-updated) | Occurs when a **link is updated** in your workspace. |
43-
| [`link.deleted`](/docs/webhooks/events/link-deleted) | Occurs when a **link is deleted** in your workspace. |
44-
| [`link.clicked`](/docs/webhooks/events/link-clicked) | Occurs when a **user clicks a link** (scoped to specific links; you choose which links to subscribe to). |
39+
| Event Type | Description |
40+
| ---------------------------------------------------- | -------------------------------------------------------- |
41+
| [`link.created`](/docs/webhooks/events/link-created) | Occurs when a **new link is created** in your workspace. |
42+
| [`link.updated`](/docs/webhooks/events/link-updated) | Occurs when a **link is updated** in your workspace. |
43+
| [`link.deleted`](/docs/webhooks/events/link-deleted) | Occurs when a **link is deleted** in your workspace. |
44+
| [`link.clicked`](/docs/webhooks/events/link-clicked) | Occurs when a **link is clicked** by a user. |

docs/webhooks/events/link-clicked.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ icon: link
55

66
import { WebhookResponseBodyParameters } from "/snippets/webhook-response-body-parameters.mdx";
77

8-
Event triggered when an end user clicks on a short link.
8+
Event triggered when a link is clicked by a user.
99

1010
<Tip>
11-
Due to the high volume nature of these events, these events are scoped to a
12-
specific link. This means that you need to specify the link when creating a webhook for this event.
11+
You can scope which links trigger a `link.clicked` webhook. When creating or editing the webhook in the dashboard, choose one of the following:
1312

14-
You can also include multiple links in the same `link.clicked` webhook – either via the dashboard or using the [`webhookIds` prop in the Links API](/docs/api-reference/links/create#body-webhook-ids-one-of-0).
13+
1. **All links** – trigger the webhook for every link in your workspace.
14+
2. **Include specific folders** (recommended) – trigger the webhook for all links in the selected folders.
15+
3. **Include specific links** – trigger the webhook only for the links you explicitly select.
16+
17+
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](/docs/api-reference/links/create#body-webhook-ids-one-of-0) when creating or updating a link.
1518

1619
</Tip>
1720

0 commit comments

Comments
 (0)