SaaSquatch Help Center

This guide covers​ the basics of navigating your referral program’s administration web portal, where to find important settings, and details about the information the portal makes available to you.

Getting Started

If your organization already has a Referral SaaSquatch program you can get someone who already has access to the project to invite you.

To get started with configuring your referral program, log in to your Referral SaaSquatch account.

If you don’t already have an account or program you can sign up for a new account. We will then send you an email with instructions on how to set your password. You will then be taken to the program setup page where you can create your referral program.

Reset Password

To reset a forgotten password:

  • Click on Forgot password on the login page.
  • Fill in the email address that you have linked to your Referral SaaSquatch Account.
  • Check your email.
  • Follow the instructions in the reset password email sent to your inbox (be sure to check your spam, promotions and updates folders).

Still having trouble?

If you are still having trouble creating or logging into your account please contact our support team who will be able to help you get up and running quickly.

Project Setup

Create a Project

Choosing the right settings when you first setup your referral program can seem like a daunting task. Our Success Center provides all the information you need to know when creating your referral program.

Invite Team Members

Once you have an account you can start inviting team members to join you on the project:

  • Click on Invite Team Members to Referral SaaSquatch located at the bottom of the Sidebar
  • Enter their email address(es)
  • Click Send Invite.

Create Additional Programs

To create additional referral programs click on the dropdown menu in the top left hand corner and select Create New Program.

Delete a Project

If you would like to delete a project please conact our support team with the name of your program and the live or test tenant alias and we can delete the program for you.

Note: Please be aware that once a project has been deleted there is not way to recover it or any data it contained.

Check Billing Details

The Billing Details of your Account can be found behind the Burgundy Gear in the top left corner.

Here you will find information on:

  • Current Subscribed Plan
    • Cost/month
    • Billing Cadence
    • Plan Features
  • Payment Information
    • Current credit card (obfuscated)
    • Option to change billing information
  • Payment History
    • A list of past payments with Order ID, Date of payment, Total amount of payment, and State of payment

If you have having trouble setting up the billing information for your program please contact our support team.

Navigating the Referral SaaSquatch program portal is designed to be simple and intuitive so that key information and settings are easy to find. The Navigation of the portal is broken down into two key areas; the navigation bar along the top, and the Sidebar along the left side.

The Navigation bar along the top provides an option to:

  • Switch between programs
  • Links to our documentation
  • A form to send a message to our support team if you need help
  • Access to account options
  • Link to logout.

The Sidebar along the left side provides access to the majority of your programs and setting divided into the two sections:

The Navigation bar along the top provides options to:

  • Switch between programs
  • Links to our documentation
  • A form to send a message to our support team if you need help access to account options
  • Access to account options
  • A link to logout

Account Settings

Click on Account along the right side of the Navigation Bar

In the Account Settings popup there are options to change one’s login email address or account password.

Change Login Email

Under Change Email Address section:

  • Enter your new email
  • Enter your current password
  • Click save

Change Password

Under Change Password section:

  • Enter your current password
  • Enter your new password
  • Re-enter your new password
  • Click save

The Sidebar along the left side provides access to the majority of your programs and setting divided into the two sections:

Test vs Live

Each Referral SaaSquatch Program has two "modes"; Live and Test. These modes both play important but different roles in the life of your program.

The functionality of your live and test modes (tenants) are very similar with only minor variation to accommodate the slight differences in the uses of each of them.

On a usage level your test mode (tenant) is designed to be used in the process of setting up your program. Use this tenant when first intgrating your referral program, and when testign connections with platforms you integrate with. Your live tenant should only be used once you have completed all your testing and configuration and you are ready to launch your referral program for your customers to use.

When making use of this guide, the majority of the functionality available in the portal can be performed in either the live or test tenants.

Details on best practices and when to use your live or test tenant can be found in our developer docs.

Test Data

In your test tenant you have to option 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 (i.e. Stripe/Recurly)
  • Your SaaSquatch account (including users, settings, and API keys)
  • Your theme and widget customizations
  • Your program details (i.e. discount amount)

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: Live tenant’s do not provide the option to delete data.


The Setup section of the portal includes important information and values needed to configure your referral program, both before and after launch.

Here you will find information and settings for:

  • The referral widget
  • Configuration options for referral email notifications
  • Integration information and configuration
  • Webhook configuration
  • Referral landing page settings

Referral Widget

Under the Setup heading on the Sidebar, select Referral Widget.

This section of the portal will display a live render of your program's referral widget. This render is identically to the embedded (live or test depending on the tenant) version of the widget which can be included in a webpage. This render provides a preview of the layout and messaging for your widget with pre-filled test data.

The Sidebar on the right hand side provides options to change various visual aspects of the widget:

  • The Customize your Widget section offers options to change the wording, colors, and font of your referral widget.

  • The Share Messaging section lets you adjust the default wording for Email, Facebook, and Twitter share messages your users share with their friends and family. This will update the share messaging in the widget and in the notification emails.

  • The Widget Preview options allow you to change the language and locale of the test render of your referral widget being displayed in the portal. This option can be extremely useful when trying to quickly test what your widget will look like when displayed to your users around the world. Want to get started with Internationalization? Contact Sales to find out more about our powerful internationalization offerings.

Email Notifications

Email notifications can be sent out to referrers when:

  • A friend signs up to trial (referral.started)
  • Their referred users completed the referral and the referrer’s reward is ready (referral.completed event).

Options for changing Email Notification settings can be found in Email Notifications under the Setup heading on the left Sidebar.

Both of the referral.started and referral.completed email types offer a wide range of possible customization changes to the default email template.

It is also possible to enable/disable either of the email types.


The preview option for each of the email event types provides a render of a desktop and mobile version of the referral email. It is also possible to test the email preview render with a different language and locale provided you program is configured correctly for internationalization.


The email templates can be edited to fit your program requirements.

Changes can be made to:

  • From Name
  • From Address
  • Subject
  • Header Image URL
  • Header Content
  • Body Content
  • Share Code CTA
  • Share Button Header
  • Footer
  • Ability to include share links.

Options are also available to:

  • Preview changes
  • Send a test version of the email to a specific email address.
  • Publish changes
  • Restore the default values

Our developer documentation provides further information about email notifications.


The Program Settings section provides the ability to configure the Company Name, Referral Landing Page, and Program rewards.

Company Name

This field will be displayed in your referral widget and notification emails so make sure it is simple and recognizable to your customers.

Referral Landing Page

The referral landing page is where the share links will direct people who are referred to your product. Often this is your main webpage, other times this is a specialized referral welcome/signup page.

Note: Please make sure to include the http:// or https:// at the front of the URL.

Good Examples:


Bad Examples:


If you have setup your referral program with Branch Metrics for mobile deep linking then this referral landing page will only apply to your desktop user. Users accessing a share link on mobile will be directed to the the app store or your mobile app as setup in your branch settings. More information on our integration can also be found in our documentation.

Program Rewards

This option gives you the ability to adjust the value of the rewards that will be given out to referral participants upon the successful completion of a referral.

You can adjust the referrer and referred user rewards independantly of one another for added customization.

Please note: changing your program rewards will only apply to future rewards. Existing rewards will not be changed.

Program Display Settings

Referral Programs created after November 2016 will include additional settings in the portal for configuring displaying the referral widget when making use of our squatch.js V2 library.

These settings allow you to configure which pages on your website you want to display the referral program, and what pages you would like to use as a conversion trigger.

Conversion URL

When you referred users have hit the goalpost for your referral program their referral needs to be converted to release the reward for the referrer. Read more about the core topics that make up a referral program in our How Referral SaaSquatch Works article.

This conversion mechanism can be triggered for a referral when a referred user lands on a specific page. This page can be set with the Conversion URL field. You can also set multiple conversion URLs.

Widget Display Rules

The Widget Display Rule settings can be used to configure what type of widget will be displayed on which page.

There are two types of widgets that can be displayed using the Widget Display Rules: the Referrer Widget, and the Referred User Widget.

Referrer Widget
Referred User Widget
Widget Displayed As CTA

To display a widget:

  • Select the type of widget you would like the Display Rule to trigger (Referrer's Widget or Referred User Widget)
  • The URL on which you would like to show the widget.
  • Place element on the page to trigger popup.
    • The Widget can also be displayed as a CTA rather than a Popup. If so, check the Show CTA option.
  • Click add rule.

You can add as many widget display rules as you would like to display the widget throughout your product.


The install page includes:

  • Program identifying information
  • Details for connecting your product to Referral SaaSquatch
  • Configuration for connecting your program with a payment provider
  • Code examples for how to go about installing your referral program in your webpage.

The test or live tenant alias are used when connecting to the Referral SaaSquatch system to identify which program (and tenant) is being referenced.

The API keys (different in live and test tenants) are often used when connecting your referral saasquatch program to other platforms, or generating checksums used in making signed requests to our system.

Payment Provider (like Stripe and Recurly) integration is also configured on this page. The Referral SaaSquatch payment provider integrations offer a easy to configure way to connect your referral program with your existing payment provider. These integrations are able to automatically track subscriptions and fulfill rewards.

The Install Code button will display a customized example of the javascript code needed which could be used to install your program on your webpage. To make use of this code, fill in the variables and checksum for the user information you wish to submit. Further information about installing the Referral SaaSqautch referral program in your website can be found in our documentation.


Webhooks allow for specific URLs to be notified of events related to your referral program using a subscription layer on a REST API. Referral SaaSquatch supports delivering these event notifications to multiple endpoints.

To add a webhook endpoint click the Create Webhook button, choose a URL (including the "http://" or "https://", and a name for the endpoint, then click Create Webhook.

Learn more about our webhooks, including in-depth examples, in our developer documentation.


Referral SaaSquatch supports integrations with a range of business apps.

Detailed setup instructions for configuring our integration with Branch, Silverpop, setting up SMTP, or default email handling can be found in our developer documentation.


The manage section of the portal includes information and options related to managing the activity of your program. This section can be found below the Setup section of the left Sidebar.

This section includes access to the:

  • Analytics - for tracking the progress of your program
  • Participant explorer - for viewing and managing participants in your referral program
  • Security - for managing your programs referrals.


The analytics section of the portal provides a wide range of rich data which can be used to review the activity and progress of your program.

Program Overview

The program overview includes statistics for the referral funnel from both the referrer and referred user perspectives.

This data can be filtered based on a specific timeframe (Today, Last 30 days, All time, etc.)

  • Unique Visitors
  • Active Referrers
  • Successful Referrers
  • Referred Visitors
  • Referred users
  • Referred Conversions
  • Timeline
  • Registered Participants

Engagement Medium

The engagement medium is the version of the referral program widget/end user experience that a user interacted with.

Share Medium

The share medium is the network or channel that a referral was made on.

User Locations

The Map functoinality in the analytics displays geographical information that is available for the users of your referral program.

Full details about the information available through our Analytics platform can be found in the Success Center.

Referral Feed

The referral feed provides a list of recent referral events for your program.

Information available in the referral feed includes:

  • Date - The date refererral event took place on
  • Referrer Info - The name and email of the referrer
  • Referred User Info - The name and email of the referred user
  • Referral Status - The status of the referral connection.


Referral Participants Tab

List includes users who:

  • Had their referral link clicked by a referred user
  • Referred a user to trial
  • Have a referred user convert to paid.

Users in this tab can be sorted by any of these three metrics.

All Users Tab

A list of all customers who have been registered in your referral program.

Selecting a user provides information such as their:

  • Full name
  • Referral code
  • Referral link.

Information on the referrals they have made as well as any rewards they may have earned is found below.

Clicking on the Manage User link opens a popup where

  • Name and email can be updated
  • Referral Status changed (or Payment Provider ID added)
  • Referral attributed
  • Manual reward created.


The Security Management System section of the portal allows for configuration of the referral moderation process which helps prevent fraudulent referrals.

The Sections here include:

  • Pending Referrals - List of Pending referrals including any applicable fraud criteria
  • Referral History - List of Historical Approved and Denied referrals

Security Options

  • General - Configuration options for what to do "When fraudulent activity is suspected on a referral"
  • Fraud Criteria - Toggle on or off the criteria analyzed for fraudulent behaviour
  • Advanced - Set the default referral status settings for incoming referrals

An overview of Security Management System can be found in our Success Center while an in-depth guide with details about the workings of this feature can be found in our developer documantation.

Additional Resources

More information about referral programs can be found in our introductory Referral Programs 101 article.

The Referral Marketing Channels that your users will interact with are also explained in our Success Centre.

If you have any further questions about implementing your referral saasquatch program, or where to find settings in the portal, please don’t hesitate to contact our support team.