sale
event happens when a user purchases your product or service. Examples include:
- Subscribing to a paid plan
- Usage expansion (upgrading from one plan to another)
Prerequisites
Before you get started, make sure you follow the Dub Conversions quickstart guide to get Dub Conversions set up for your links:Quickstart
1
Generate your publishable key
Before you can track conversions on the client-side, you need to generate a publishable key from your Dub workspace.To do that, navigate to your workspace’s Analytics settings page and generate a new publishable key under the Publishable Key section.

2
Allowlist your site's domain
Then, you’ll need to allowlist your site’s domain to allow the client-side conversion events to be ingested by Dub.To do that, navigate to your workspace’s Analytics settings page and add your site’s domain to the Allowed Hostnames list.This provides an additional layer of security by ensuring only authorized domains can track conversions using your publishable key.
You can group your hostnames when adding them to the allow list:

example.com
: Tracks traffic only fromexample.com
.*.example.com
: Tracks traffic from all subdomains ofexample.com
, but not fromexample.com
itself.
When testing things out locally, you can add
localhost
to the Allowed
Hostnames list temporarily. This will allow local events to be ingested by
Dub. Don’t forget to remove it once you’re ready to go live!3
Install @dub/analytics package
Next, install the Dub analytics script in your application.You can install the You must configure the publishable key you generated in step 1 when installing the analytics script. Without this key, client-side conversion tracking will not work.
@dub/analytics
script in several different ways:React
Add Dub Analytics to your React app
Manual installation
Add Dub Analytics to your website
Google Tag Manager
Add Dub Analytics via GTM
Framer
Add Dub Analytics to your Framer site
Shopify
Add Dub Analytics to your Shopify store
WordPress
Add Dub Analytics to your WP site
Webflow
Add Dub Analytics to your Webflow site
Client-side sale tracking
Once the analytics script is installed, you can start tracking sale events in your application on the client-side.Property | Required | Description |
---|---|---|
customerExternalId | Yes | The unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer. |
amount | Yes | The amount of the sale in cents. |
paymentProcessor | No | The payment processor that processed the sale (e.g. Stripe, Shopify). Defaults to “custom”. |
eventName | No | The name of the event. Defaults to “Purchase”. |
invoiceId | No | The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID. |
currency | No | The currency of the sale. Defaults to “usd”. |
metadata | No | An object containing additional information about the sale. |
- Completing a checkout or order
- Subscription payment
- Invoice payment
- Any paid trial or demo conversion
Client-Side Conversion Tracking Limitations:
- Ad blockers – Users with ad blockers may prevent tracking scripts from loading.
- JavaScript disabled – Events won’t be tracked if users have JavaScript disabled.
- Network issues – Failed network requests won’t retry automatically.
- Privacy concerns – Some users may block client-side tracking for privacy reasons.
View conversion results
And that’s it – you’re all set! You can now sit back, relax, and watch your conversion revenue grow. We provide 3 different views to help you understand your conversions:- Time-series: A time-series view of the number clicks, leads and sales.

- Funnel chart: A funnel chart view visualizing the conversion & dropoff rates across the different steps in the conversion funnel (clicks → leads → sales).

- Real-time events stream: A real-time events stream of every single conversion event that occurs across all your links in your workspace.
