webhook-payload.json
Workspace-level events
These events are triggered in the context of your entire workspace:link.created
link.updated
link.deleted
lead.created
sale.created
partner.enrolled
commission.created
link.created
This event is triggered when a new link is created in your Dub workspace. The event payload contains the created link’s details.
Here’s an example payload:
Sample payload
Sample payload
link.created
link.updated
This event is triggered when a link is updated in your Dub workspace. The event payload contains the updated link’s details.
Here’s an example payload:
Sample payload
Sample payload
link.updated
link.deleted
This event is triggered when a link is deleted in your Dub workspace. The event payload contains the deleted link’s details.
Here’s an example payload:
Sample payload
Sample payload
link.deleted
lead.created
This event is triggered when a new lead is created via Dub Conversions. The event payload contains the following:
eventName
: The name of the event that was tracked.customer
: Details about the customer that signed up.click
: Details about the click event that led to the lead event.link
: Details about the referral link that the lead event is associated with.
Sample payload
Sample payload
lead.created
sale.created
This event is triggered when a new sale is tracked via Dub Conversions. The event payload contains the following:
eventName
: The name of the event that was tracked.customer
: Details about the customer that made the purchase.click
: Details about the click event that led to the sale event.link
: Details about the referral link that the sale event is associated with.
Sample payload
Sample payload
sale.created
partner.enrolled
This event is triggered when a new partner is enrolled in your partner program. The event payload contains the following:
partner
: Details about the partner that was enrolled.links
: An array of the partner’s referral links.
Sample payload
Sample payload
partner.enrolled
commission.created
This event is triggered whenever a new commission is generated in your partner program — either automatically through a tracked conversion or manually via your dashboard.
The event payload contains the following:
partner
: Details about the partner that earned the commission.customer
: Details about the customer that made the purchase.userId
: The ID of the user who created the manual commission. You can use this field to distinguish manual commissions from other types of commissions.
Sample payload
Sample payload
commission.created
Link-level events
Due to the high volume nature of these events, these events are scoped to a specific link. This means that you need to specify the link when creating a webhook – though you can select multiple links for the same webhook if you’d like.link.clicked
This event is triggered when a user clicks on a link. The event payload contains all the details about the click event.
Here’s an example payload:
Sample payload
Sample payload
link.clicked