Who is this article for?
This article will be useful to you if are a company on PartnerStack looking for a high-level overview of integrations.
In-depth technical details can be found in our developer docs at docs.partnerstack.com.
Mobile integration docs can be found here.
Connecting PartnerStack to your web application
1. Tracking Referred Signups
The start of every integration with PartnerStack is also the most important step. This is the connection between a partner (referrer) and your new user (referee). This relationship is contained within a customer in PartnerStack.
Each partner (reseller, affiliate, etc.) has a
partner_key which is used to tag traffic coming through a referral link to land on your website.
When a user clicks on a link, PartnerStack sets a
growSumoPartnerKey on the user's browser. The value of this cookie is the partner's unique
partner key .
The snippet provides the following functionalities:
Creating a customer
A customer in PartnerStack is a referred user who has signed up to your website.
Each customer has a:
Whether you use GrowSumoJS standalone, or in conjunction with the GrowSumo API, you must create a customer to represent a referred sign up BEFORE triggering any rewards. All rewards are connected to a customer.
2. Triggering a Reward
Now that you've created a Customer it's time to trigger a reward for the partner.
PartnerStack handles the logic and payout of your rewards, all you need to do is provide some information about the event when it occurs.
Informing PartnerStack a rewardable event has occurred
Step one is to set up some triggers in your PartnerStack account, this will tell PartnerStack what events to listen for, and what actions to carry out when they are detected. You can learn more about setting up these triggers here.
Once a trigger is set up it will activate based on the info you send to the PartnerStack API. Most commonly triggers will activate on a transaction event.