SaaSquatch Help Center

An overview of what the structure of your referral program will look like, an outline of the technical components that will be involved in setting up your SaaS business's referral program, and how each of these components tie together to create a full referral loop.

The focus of this SaaS referral program guide is on making use of an “API-only” Referral SaaSquatch program including the use of our squatch.js library and either Dollar Credit or Percent Discount rewards.

Information on our payment provider integrations (eg. Stripe and Recurly) can be found in our docs.

This Program Outline is based around the same core topics found in the How Referral SaaSquatch Works article found in our Success Center.

A high-level look at referral programs for SaaS business can be found back in the SaaS Referral program Guide Intro.

Further details, including code examples, on how to integrate this referral program into your product can be found in the companion Installation Guide in our technical documentation.


Existing customers can enroll in the referral program in two different ways:

  • Referral Widget on the website behind a login [Desktop & Mobile]

    Placing the Referral Widget behind a login will allow your existing customers to interact with the referral program. Use the Squatch JS library to load the Referral Widget.

  • Broadcast email to notify existing customers of the program. Provide Referral SaaSquatch with a list of users you would like to enroll in the Referral Program. Referral SaaSquatch registers these users and provides an CSV export file with each user’s unique sharelinks. This CSV file can be imported into an email platform, like Mailchimp, to inform your users about the referral program and provide them with their unique sharelink. Please contact support to find out the required format for the CSV user data you would like to import.

The above steps will allow the customers to refer their friends by sharing their unique share link.

Identification & Attribution

When a friend clicks on the unique share link we can redirect them to the landing page for your referral program. This can be a dedicated page or simply your website’s homepage. On iOS or Android we can redirect them, using our Branch integration, to the app store to install your app.

After the referred user fills out the signup form, identify this referred user to Referral SaaSquatch using one of these methods:

  • Load the Squatch JS init call on the page [Desktop]

    This code snippet will identify the user to SaaSquatch. This call will also automatically check for a referral cookie with the referrer’s referral code. This automatically takes care of creating the referral connection. (Attribution)

  • Use the SaaSquatch REST API to Create the Account & Create the User [Desktop & Mobile]

    When using the API, the referral connection (Attribution) has to happen by capturing the referral code from the referral cookie and include it when creating the Account. The Squatch JS autofill function can help facilitate this.

  • Load the Mobile Widget or use the Mobile SDK inside the mobile app [Mobile]

    The Mobile Widget and Mobile SDK register new participants and show the referral widget to allow users to make referrals. The Branch integration stores the referral code of the person who referred them to easily build the referral connection.


Once the referred user hits the goalpost, Referral SaaSquatch should be informed so we can mark this referral as complete in our system and generate a reward for the referrer.

This step can be done in three different ways:

  • Manually through the Referral SaaSquatch Portal by looking up the user and changing their status
  • Using the Squatch JS init call and adding the 'account_status': 'PAID' parameter
  • Through the REST API by updating the Account and setting the status to PAID


If you are running a double sided referral program we need to fulfill the rewards for both the referrer and the referred user.

Whenever a reward is created by the Referral SaaSquatch system there is a webhook event generated. You can subscribe to these webhooks and listen for the reward.created event to know when to go about rewarding your users.

The rewards for both parties will be as following:

  • Referred User

    This reward is generated when a Referred User signs up through your platform and you identify them to us. The webhook event reward.created has a rewardSource parameter that will says “REFERRED”. Use this webhook event to kick off reward fulfillment inside your payment system.

  • Referrer

    When the referred user’s account status was updated (see Conversion step), we mark the referral as successful and generate a reward. The webhook event reward.created has a rewardSource parameter that will say “FRIEND_SIGNUP”. Use this webhook event to kick off reward fulfillment inside your payment system.

After fulfilling each reward, make sure to mark these rewards as redeemed using the Redeem a Single Reward API call. This will make sure that the user’s reward progress is updated inside the Referral Widget.

Next Steps

The companion installation guide for this overview can be found in our technical docs.

Additional Information

The information above provides an overview showing how each of the individual components of a referral program tie together to create a full referral loop.

More information on How Referral SaaSquatch Works, as well as our Getting Started Referral Program 101 Guide can be found in our Success Center.

If you have any further questions about information in this guide please don’t hesitate to contact our support team.