Public Methods
React Native API Integration
1. Add a Subscriber
POST
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers
Request Body
When using this method please take note of your Campaign Goal as our tracking logic will depend on if you are tracking a single or multi-step conversion event.
GOAL: One Conversion Event If you have your Campaign Goal set up to track one conversion event, the following tracking logic will take place:
If a referral, a referral will be automatically created and set to Confirmed in the correct campaign.
If not a referral, an organic subscriber will be created in the campaign UUID specified.
If the subscriber exists in our database, the subscriber will be 'identified'. Data is not overwritten. Additional data will be created.
GOAL: Two or Three Conversion Events If you have your Campaign Goal set up to track two or three conversion events, the following tracking logic will take place:
If a referral, a referral will be created and set to Pending in the correct campaign.
If not a referral, an organic subscriber will be created in the campaign UUID specified.
If the subscriber exists in our database, the subscriber will be 'identified'. Data is not overwritten.
To add a subscriber (for example, post a successful signup or login) call the function and send the params information such as email address and name. The minimum values you should send for the endpoint to work are the following:
To identify and create a referral, you must also send either the setReferrer OR the required mobile params so that our matching algorithm can automatically identify a referral.
NOTE: The mobile parameters must be sent in the correct format for our system to automatically identify and create a referral. See the Getting Started section here.
The accepted Screen Size formats are:
2. Add Pending Referral
POST
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/pending_referral
This method is most commonly used to create a referral entering the 1st step of your multi-step conversion event funnel (i.e. after a referred user successfully signs up for your app). If you want us to automatically add every user to your campaign and determine if the user is a referral or not, use the Add Subscriber method instead. This logic only checks for referrals:
Tracking Logic
GOAL: Two or Three Conversion Events
Your campaign Goal must be set up to track two or three conversion events, and then the following tracking logic will take place:
If a referral, a referral will be automatically created and set to Pending in the correct campaign.
If not a referral, no subscriber will be created.
Request Body
To add a pending referral, simply call ReferralHero's createPendingReferral
function and send the referralParams
data.
The minimum values for this endpoint to work:
OR:
NOTE: The mobile parameters must be sent in the correct format for our system to automatically identify and create a referral. See the Getting Started section here.
3. Track Referral
POST
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/track_referral_conversion_event
This method is used for tracking a referral conversion event (i.e. a purchase, but can be any conversion event).
Tracking Logic:
If a referral and pre-existing in the campaign as Pending
OR
If a referral and setReferrer or mobile params are provided, a referral is automatically created in the correct campaign and
The Referral Is Set To:
Confirmed (if tracking two conversion events)
Unconfirmed (if tracking three conversion events)
Note:
1. Your campaign must be set up as a custom event or a multi-step event otherwise, an error will return.
2. If the referral is present in ReferralHero with pending status, a successful response custom_event_completed
will return.
3. If the referral unique identifier is not present in the ReferralHero, but the referrer unique identifier is present, a successful response custom_event_completed
with the data of the new confirmed referral will return.
4. If a referral exists but the referral status is not pending, the error custom event is already completed
will return.
5. If the referral unique identifier is not present in ReferralHero and the referrer is also not provided in the API, the error referer is invalid or not present
will return.
6. If the referral status is unconfirmed or confirmed, the error custom event is already completed
will return.
When tracking referrals on your App you should ALWAYS send the ACTUAL unique identifier (email, phone number, crypto wallet address, or other ID) of the user in referralParams class Object.
Request Body
uniqueIdentifier is a placeholder.
When tracking referrals on your App you should ALWAYS send the ACTUAL unique identifier (email, phone number, crypto wallet address, or other ID) of the user in referralParams class Object
4. Confirm Referral
POST
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber_id/confirm
Use this method when your Campaign Goal is set to track three conversion events and you want to confirm a referral when your third conversion event occurs (complete profile, upgrade to a paid plan, end of the trial, etc).
Tracking Logic:
If a referral and pre-existing in the campaign as Unconfirmed
The Referral Is Set To:
Confirmed (if tracking three conversion events)
Note: only verified referrals can be confirmed. Trying to confirm a non-verified referral will return a subscriber_not_found
error.
Request Body
5. Organic Track Referral
POST
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/organic_track_referral
If you would like to add an organic subscriber or a track referral on the conversion page to your referral campaign, you can use the following method. This method would most commonly be used if the user has not been previously added to your campaign and instead directly passes through a post-checkout/subscribe event.
Tracking Logic:
If a referral and pre-existing in the campaign as Pending
OR
If a referral and setReferrer or mobile params are provided, a referral is automatically created in the correct campaign and
The Referral Is Set To:
Confirmed (if tracking two conversion events)
Unconfirmed (if tracking three conversion events)
OR
If not a referral, an organic subscriber is created in the campaign UUID specified.
Request Body
The Unique Identifier is the only required body parameter, otherwise, all other available subscriber attributes can be found above under 'Add a Subscriber'.
If the referral is NOT pre-existing in the campaign (and you want to identify and create a referral), you must send either the setReferrer OR the required mobile parameters in the correct format so that our matching algorithm can automatically identify a referral. See the Getting Started section here.
6. Update Subscriber Details
PATCH
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber_id
This method is used to update various user-related data like username, address, etc. Request parameters are the same as before in the Add a Subscriber API.
Required body parameters are noted below, otherwise, all other available subscriber attributes can be found above under 'Add a Subscriber'.
Request Body
7. Get Subscriber Details
GET
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber_id
This method is used to get the details of a particular subscriber.
Path Parameters
8. Delete Subscriber
DELETE
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber_id
This method is used to Delete a Subscriber.
Path Parameters
9. Capture Share
POST
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber_id/click_capture
This method is used with parameters like 'copy', 'sms', 'facebook', 'twitter', etc. to capture a Share Event.
Request Body
10. Get My Referrals
GET
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber-id/referrals_data
This method is used for retrieving all referrals of the specific subscriber.
Path Parameters
11. Get Leaderboard
GET
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/leaderboard
This method is used for retrieving the campaign leaderboard.
Path Parameters
12. Get Referrer
GET
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/referrer
This method is used to retrieve the referrer of a user. By calling this method, you would know if someone was a referral or not, and then could:
Apply a discount code automatically to the checkout process
Personalize text shown on a page
Path Parameters
NOTE:
The mobile parameters must be sent in the correct format for our system to automatically identify a referral. See the Getting Started section here.
13. Get Rewards
GET
https://dev.referralhero.com/api/sdk/v1/lists/:uuid/subscribers/:subscriber_id/rewards
Use this method to Get Rewards unlocked by a specific subscriber.
Path Parameters
Last updated