Referral Program With Objectives Setup Guide

🔗 Setup

When a new lead clicks on the unique share link, they should be redirected to the signup page on your website. When using the squatch.js JavaScript library, the referral connection will be automatically picked up if they clicked a share link.

Alternatively, if the user is on iOS or Android they can be redirected using our Branch integration to the app store to install your app. The Branch integration stores the referral code of the person who referred them to easily build the referral connection.

After the Referred User completes your signup process, identify this Referred User to SaaSquatch. If you are identifying the Referred User through the SaaSquatch REST API, be sure to explicitly include the Referrer’s referral code so that the referral is correctly attributed back to the Referrer.

🔗 Rules

The Referral Program rules let you choose when the referral qualifies for conversion and when the users will be rewarded.

🔗 Types of conversions

There are two ways to trigger conversion: via receipt of qualifying purchase events and insertion/update of custom fields. The Referrer User will receive their reward when the referral is converted.

🔗 First Purchase

Convert the referral when the Referred User makes a purchase. You can optionally set a minimum purchase value for the event in order for an event to qualify. If the revenue field is below the minimum value, the referral will not convert.

🔗 Custom Field

Another way to convert your referral is with a user-based custom field. Select the name of the field and the condition required for causing a referral.

Examples:

Field Name	Operator	Value
signedUp	equal to	"yes"
testField	less than or equal to	12
myConversionField	greater than or equal to	70
myConversionField	equal to	"myConversionValue"

The value field supports numeric, boolean and string types.

When the user is updated the program will check to see if the condition is met and convert the referral accordingly.

🔗 Rewarding the Referred User

There are three settings for rewarding the referred user:

🔗 Never

The referred user will not be rewarded.

🔗 When they are referred

The Referred User will be rewarded when the referral is started. This most likely means that the Referred User will be rewarded before the Referrer (such as upon sign-up or check-out), but note that it is possible for the referral to convert at the same moment it is created depending on your conversion rules.

For example, you might want to provide the Referred User with a discount to use when shopping and then reward the Referrer once the Referred User has completed a purchase.

🔗 On conversion

The Referred User will be rewarded when the referral converts, at the same time as the Referrer.

🔗 Referrer reward limit

You can optionally set a reward limit for the Referrer. When a user reaches the reward limit for the program, they will receive an email explaining that no more rewards will be given. After the limit is reached, the user may continue to refer others, but they will not be rewarded when those referrals convert (the Referred Users are still eligible for rewards).

🔗 Retracting referrals

Another feature of the Referral Program is the ability to retract referral rewards after they have already been issued. This is optional, but you may want to do it for a variety of reasons, such as if a customer refunds their purchase or if they cancel their subscription. Referral retraction is triggered by a custom event. You may set either just an event key or an event key with a filter.

If you are using an event key only, all events matching the key set in the rules will cause a retraction.

When using an event key with a filter, the program will check for the existence of a field in the event along with some condition. This is similar to the custom field conversion method outlined above.

Examples:

Field Name	Operator	Value
userCancelled	equal to	true
userCancelled	equal to	"yes"
testField	less than or equal to	12
myRetractionField	greater than or equal to	70
myRetractionField	equal to	"myRetractionValue"

Like custom field conversions, the value field supports numeric, boolean and string types.

🔗 Retraction settings

If a retraction event is recorded, the rewards can be cancelled for either the Referred User, Referrer, or both.

🔗 Launching

Before launching, check the status of the Technical Setup area. The referral program provides a number of automated tests that can check the health of your program implementation. The results will be shown here. It is still strongly recommend to perform thorough manual testing of your program to ensure everything is working as intended.

Once the tests are passing, or if you are comfortable launching without them, press the Launch button. Your program is now live and watching for referral conversions.