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 mobile platform's referral program, and how each of these components tie together to create a full referral loop.

The focus of this Mobile 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 covered in the How Referral SaaSquatch Works Success Center article.

A high level look at referral programs for mobile platforms can be found back in the Mobile 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 participate in the referral program in several different ways:

  • Referral Widget in the app behind a login.
    Placing the Referral Widget behind a login will allow your existing customers to interact with the referral program. Use each user’s personalized URL to load the Mobile Widget in an iFrame.
  • Use the Mobile SDK to build your referral program into your native app's brand experience.

The above steps will allow the customers within the app to refer their friends by sharing their unique share link. There are also several other methods of engaging users outside of the app by providing them program information and their unique share links, such as broadcast/marketing emails, push notifications, etc.

Identification & Attribution

When a friend clicks on the unique share link we can redirect iOS or Android users, 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 the signup flow for an account, identify this referred user using one of these methods:


Once the referred user hits the goalpost, 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 SaaSquatch Portal by looking up the user and changing their status
  • Using the Mobile Widget URL and adding the account_status = "PAID" parameter
  • Through the REST API by Updating the Account and setting it to PAID


If you are are running a double sided referral program, you need to fulfill both of these rewards.

Whenever a reward is created by SaaSquatch there is a webhook event generated. You can subscribe to these webhooks and listen for the reward.created event. 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. You can filter by the rewardSource parameter equal to REFERRED and fulfill this reward inside your 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 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.