init

The init function is the core of Squatch.js. This function lets you identify your users, show them referral widgets, generate referral links and codes, automatically attribute referrals, track conversions and more all from one place. The first time that a user is identified to Squatch.js with this method, it will be created in Referral SaaSquatch and can later be looked up via the API.

You must always call init before you can use any part of squatch.js.

_sqh.push(['init', parameterObject]);

Parameters

Example

<script type="text/javascript">
var _sqh = _sqh || [];

// Push user details for a user who is logged in to your system
_sqh.push(['init', {
   tenant_alias: 'test_bpinhag9yagag',
   account_id: 'abc',
   payment_provider_id: 'cus_1234',
   user_id: '5678',
   email: 'bob@example.com',
   first_name: 'Bob',
   last_name: 'Testerson',
   user_image: 'http://myapp.example.com/img/user_5678.jpg'
}]);

// Include squatch.js
(function(){function l(){var s=document.createElement("script");s.type="text/javascript";s.async=true;s.src=location.protocol+"//d2rcp9ak152ke1.cloudfront.net/assets/javascripts/squatch.min.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(s,t)}if(window.attachEvent){window.attachEvent("onload",l)}else{window.addEventListener("load",l,false)}})();
</script>

Troubleshooting

Having trouble making a successful Squatch JS init call? When loading the Referral Widget in EMBED or POPUP mode, it can return a screen showing that the Referral Program is temporarily unavailable. Please see an example of this screen below. If you are running Squatch JS init in NOCONTENT mode, you can open your browser's console to retrieve this error code.

In the screenshot above, look for the error code in the right bottom corner and reference this code in our issue code list to diagnose why the Squatch JS init call failed. If you are still experiencing problems, please don't hesitate to contact our Support team.

autofill

Use autofill on your payment page to connect a referral's coupon code to your payment form. Coupon code input elements can be hidden elements.

_sqh.push(['autofill', jQuerySelector]);
_sqh.push(['autofill', callbackFn]);

Parameters

Autofill accepts either a jQuery selector of an input element to autofill, or a callback function. If you want to use both, call autofill multiple times (like in the example below).

Example

<script type="text/javascript">
var _sqh = _sqh || [];

// squatch.js must be initialized to call autofill, but user information is not required
_sqh.push(['init', {
   tenant_alias: 'test_bpinhag9yagag'
}]);

// Example 1 -- use a callback function
var autofillCb = function(code){
    window.alert('The coupon code of the person that referred you is: ' + code);
};

_sqh.push(['autofill',  autofillCb]);

// Example 2 -- use a jQuery selector
_sqh.push(['autofill', '#my_coupon']);

// Include squatch.js
(function(){function l(){var s=document.createElement("script");s.type="text/javascript";s.async=true;s.src=location.protocol+"//d2rcp9ak152ke1.cloudfront.net/assets/javascripts/squatch.min.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(s,t)}if(window.attachEvent){window.attachEvent("onload",l)}else{window.addEventListener("load",l,false)}})();
</script>

<input type="text" name="Coupon" id="my_coupon" value="" /> <!-- This input box will get autofilled --> 

open

You can programatically open the referral program widget on any page of your application where Referral SaaSquatch javascript has been initialized.

Example

<script type="text/javascript">
    _sqh.push('open');
</script>

Pre-Opened Widget

The referral program widget can be pre-opened on any page of your application where Referral SaaSquatch javascript has been initialized. To do this, add the paramter, "squatch_open" to the URL.

Example

 http://example.com/?squatch_open

close

You can programatically close the referral program widget on any page of your application where Referral SaaSquatch javascript has been initialized.

Example

<script type="text/javascript">
    _sqh.push('close');
</script>

subscribe

Subscribes the provided callback to the given event; any time an event of the provided name (eventName) is published via the widget, this subscribe call will be triggered.

_sqh.push(['subscribe', String eventName, function([payload]) {
  / code to execute after event is published from the widget /
]);

Parameters

Example

_sqh.push(['subscribe', 'changeUrl', function(payload) { window.location = payload.url; }]);

getReward REMOVED

_sqh.push(['getReward', function(reward){ ... }]);

<script type="text/javascript">
var _sqh = _sqh || [];

// Push user details for a user who is logged in to your system
_sqh.push(['init', {
   tenant_alias: 'test_bpinhag9yagag',
   account_id: 'abc',
   payment_provider_id: 'cus_1234',
   user_id: '5678',
   email: 'bob@example.com',
   first_name: 'Bob',
   last_name: 'Testerson'
}]);

_sqh.push(['getReward', function(reward){
    // Gets the current user's (e.g. Bob Testerson) reward
    // e.g. show this on the My Account page to show the current user's info
}]);

// Include squatch.js
(function(){function l(){var s=document.createElement("script");s.type="text/javascript";s.async=true;s.src=location.protocol+"//d2rcp9ak152ke1.cloudfront.net/assets/javascripts/squatch.min.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(s,t)}if(window.attachEvent){window.attachEvent("onload",l)}else{window.addEventListener("load",l,false)}})();
</script>

getRewardBalance REMOVED

_sqh.push(['getRewardBalance', function(rewardBalance){ ... }]);

<script type="text/javascript">
var _sqh = _sqh || [];

// Push user details for a user who is logged in to your system
_sqh.push(['init', {
   tenant_alias: 'test_bpinhag9yagag',
   account_id: 'abc',
   payment_provider_id: 'cus_1234',
   user_id: '5678',
   email: 'bob@example.com',
   first_name: 'Bob',
   last_name: 'Testerson'
}]);

_sqh.push(['getRewardBalance', function(rewardBalance){
    // Gets the current user's (e.g. Bob Testerson) reward balance
    // e.g. show this on the My Account page to show the current user's info
    console.log(rewardBalance.0.totalAssignedCredit);
}]);

// Include squatch.js
(function(){function l(){var s=document.createElement("script");s.type="text/javascript";s.async=true;s.src=location.protocol+"//d2rcp9ak152ke1.cloudfront.net/assets/javascripts/squatch.min.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(s,t)}if(window.attachEvent){window.attachEvent("onload",l)}else{window.addEventListener("load",l,false)}})();
</script>