Quickstart
Learn how to set up your referral/affiliate program with Dub Partners.
Dub Partners require a Business plan subscription or higher.
Dub Partners lets you build powerful, scalable referral and affiliate programs with 1-click global payouts and white-labeling functionality.
In this guide, we’ll walk you through the steps to get started with Dub Partners:
- Install the
@dub/analytics
client-side SDK - Install the Dub server-side SDK + track conversion events
- Set up your partner program
Step 1: Install the @dub/analytics
client-side SDK
First, you’ll need to install the @dub/analytics client-side SDK.
This script detects the dub_id
query parameter and storing it as a first-party cookie, which will be used to attribute subsequent conversion events to the original link.
On top of that, it also:
- lets you track clicks on the client-side using query parameters (e.g.
?via=john
) - automatically fetch the partner and discount data for a given link – which is helpful for displaying dual-sided incentives
You can install the @dub/analytics
script in several different ways:
React
Add Dub Analytics to your React app
Manual installation
Add Dub Analytics to your website
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
You can verify the installation with the following tests:
- Open the browser console and type in
_dubAnalytics
– if the script is installed correctly, you should see the_dubAnalytics
object in the console. - Add the
?dub_id=test
query parameter to your website URL and make sure that thedub_id
cookie is being set in your browser.
If both of these checks pass, the script is installed correctly. Otherwise, please make sure:
- The analytics script was added to the
<head>
section of the page - If you’re using a content delivery network (CDN), make sure to purge any cached content
Once the script is installed, make sure to verify that client-side click tracking is working as expected by checking if the following is true:
- There is a successful
/track/click
request in your browser’s Network tab (and no errors in the Console tab). - The
dub_id
cookie is being set upon a successful/track/click
request. - The click tracked correctly in the Events tab of your Dub workspace.
Step 2: Install the Dub server-side SDK + track conversion events
If you are using Shopify, you can skip this step since our Shopify app will automatically track conversions for you. Read the Shopify integration guide for more information.
Dub uses server-side event tracking to track conversions, which is more reliable than client-side tracking. Depending on which framework you’re using, you can use our native SDKs:
TypeScript
TypeScript library for the Dub API
Go
Go library for the Dub API
Python
Python library for the Dub API
Ruby
Ruby library for the Dub API
If you’re using a framework that isn’t listed, you can use the Dub REST API to track events on the server-side:
Once you install the SDKs, you can start tracking conversion events.
Tracking lead events
The first event you’ll want to track is a lead
event. This happens when a user performs an action that indicates interest in your product or service. This could be anything from:
- Signing up for an account
- Adding a product to cart
- Joining a mailing list
Our most common lead event is Sign Up
, which happens when a user signs up for an account. Depending on which authentication framework you’re using, here are a few examples of how to send Sign Up
lead events:
The lead event will serve as the source of truth for the customer’s identity and which link they came from. This means that all subsequent actions performed by the customer (e.g. upgrading their plan, purchasing a product) will automatically be attributed to the original link.
To learn more about tracking lead events with Dub, refer to the following resources:
Tracking lead events
Read the full guide on tracking lead events with Dub
POST /track/lead endpoint
View the full list of attributes you can pass when sending a lead event
Tracking sale events
The second event you’ll want to send is a sale
event. This happens when a user purchases your product or service. This could be anything from:
- Subscribing to a paid plan
- Usage expansion (upgrading from one plan to another)
- Purchasing a product
Depending on which payment processor you’re using, we offer native integrations for the following:
Alternatively, you can also send sale events manually using our SDKs or the POST /track/sale
API endpoint.
To learn more about tracking sale events with Dub, refer to the following resources:
Tracking sale events
Read the full guide on tracking sale events with Dub
POST /track/sale endpoint
View the full list of attributes you can pass when sending a sale event
Step 3: Set up your partner program
Once you have conversion tracking up and running, you can follow these steps to set up your partner program:
- Go through the program onboarding flow to create your program.
- If you’re migrating from another platform, you can also import your partners and historical conversions (e.g. from Rewardful).
- Connect your bank account for partner payouts.
- Invite your partners to join your program + set up your program application form for future partners.
- Create custom reward rules and dual-sided incentives to incentivize partners to share your link with others.
- Set up a whitelabeled referral dashboard that lives directly inside your app so your users can automatically enroll in your partner program without leaving your app.