SaaSquatch Help Center

Understanding the referral program development process with Referral SaaSquatch.

Test vs Live

Each Referral SaaSquatch Program has two modes: Live and Test. These modes (tenants) both play an important role in the lifecycle of your referral program.

The functionality of your live and test tenants are designed to be very similar so that there are as few changes as possible when transitioning from your test to live tenant.

The intended use of each of your tenants can be summarized as follows:

Test Live
  • Design
  • Development
  • Testing
  • Payment System Sandbox
  • Live tenant configuration on final Staging environment
  • Running your Live Referral Program

Example Development Process

The following flow chart provides an example of what a development process could look like when integrating your referral program into your product:

Development Process

Example Development Process Explanation

Development Stage Description
1. Design Planning a software solution (to launch a referral program).
2. Development Creation of the software solution intended to lauch a referral program.
3. Unit (Local) Testing Testing that each of the components of the referral program functions as intended.
4. Deploy to Staying Environment Once the referral program has passed initial testing it can be deployed to the staging environment.
5. Integration (Staging) Testing Testing how the referral program works in conjunction with the rest of your platform.
6. Quality Assurance
Ensuring the all the goals of the project (to launch a referral program) have been completed to a satisfactory level, and that the solution works as expected.
7. Live Tenant Configuration
With the mechanics of your referral program confirmed to be working using your Test tenant you can begin the process of deploying your referral program to your production environment.

As part of the transition from your Test ➡ Live tenant a number of peices need to be swapped over to point to your Live tenant.

The following items should be changed and checked before your referral program is fully configured on your Live tenant:
  • Tenant Alias - test_alu125hh1si9w51hsahuilw921
  • Tenant API key TEST_BHASKh5125Las5hL125oh3VbLmPxUSsLIVE_saLhhP5ohLSS3bB115sKLA5x5UHV22m
  • Copy and Messaging - The copy and messaging within the widget, share options, and emails is independantly configurable between tenants. Make sure that the copy and messaging in the widget, share options, and emails is correctly configured on your live tenant before it is made available to customers.
With each of these components updated to point to your Live tenant your Live referral program should be ready for use.
8. Live Referral Program
Your Live Referral Program is now ready to be deployed from your staging ➡ production environment.

It is recommeneded to run through at least one final full test of the full referral loop before publicizing your referral program.
Please note: this test referral on your live tenant, like all data on your live tenant, cannot be deleted.
9. Optimization Launching your referral program is only the first step in running a successful referral program. As you begin to generate traffic you can begin to optimize your referral program to make it even more successful.


Your referral program portal provides access to the configuration settings for both your test and live tenants.

Details about functionality in the portal can be found in our Navigating the Referral SaaSquatch Portal article.


Your referral SaaSquatch program makes dubugging on your Test tenant easier by exposing additional logging.

Our Squatch.js Library provides the following debugging tools to help you work out issues as you impliment your referral program:

Error codes displayed in the widget help to identify any problem as when displaying the widget.

Status updates, and error messages, are displayed on the console to help troubleshoot as you call squatch.js methods:

Test Data

Your test tenant you also provides the ability to delete test data.

Data that WILL be deleted:

  • Users, accounts, and referrals
  • Analytics events

The following data WILL NOT be deleted:

  • Any data stored in external payment systems (e.g. Stripe/Recurly)
  • Your SaaSquatch Account (including accounts of your other team members
  • Your theme and widget customizations
  • Your program settings, like reward settings, and API keys

To access this functionality:

  • Select Settings under the Setup menu in the Sidebar
  • Click Delete Test Data
  • Toggle the I would like to delete my test data toggle from No to Yes
  • Click Delete.

Please note: Data on the Live tenant cannot be deleted.

Additional Resources

If you would like to dive deeper into the world of Referral Programs and our platform, we recommend checking out the following articles:

  • Learn more about the structure of a referral program in our How Referral SaaSquatch Works article.
  • Explore more of the configuration options available in the SaaSquatch Portal in our Using Referral SaaSquatch article.
  • Learn more about how to protect your referral program against unwanted referral activity by reading up on our Security Management System.
  • Our SaaS Guide provides details, examples and further detail on how to integrate the SaaSquatch referral program in your product.