JavaScript API Library

Part of the onsite JavaScript library, these functions offer an easy alternative to using traditional server-to-server integrations to connect with the API.

Include these easily configurable JavaScript functions on your site, allowing the user's browser to communicate directly with the system to perform actions including signing up a user, adding an item to a cart, making a purchase, or a custom event. These functions are fully compatible with popular tag managers including Google Tag Manager, allowing for quick and easy implementation. Note that each of these functions are capable of initiating Lifecycle Optimizer flows for the user in response to the action that they represent. These JS calls offer a subset of the many capabilities of the API. If you have sufficient development resources, it is recommended that you consider coding a server-side API integration, as AJAX requests from the browser introduce the possibility of occasional dropped calls due to latency. However, the success/error responses provided by these functions offer the opportunity to compensate for any such issues that may arise. It's simple to get up and running. Use a tag manager or copy and paste the following script tag into your site.

Copy

<script src="https://ak.sail-horizon.com/spm/spm.v1.min.js"></script><script>Sailthru.init({ customerId: <yourId> });</script>

For details about setting up this latest JavaScript for all other functions, please see Personalization Engine Setup. Note that these simple integration functions are also available for our clients using v0.0.4 of the script tag.

userSignUp

Add a user by email address, or modify data for an existing user. You can optionally add or update Natural List membership(s), user var data, and an acquisition source.

The function will update an existing user profile if the email address already exists as a user profile key.
Recent pageviews, recorded to a cookie while the user was browsing anonymously, are automatically passed into the function to build the new or existing user's interest profile.
The response will contain the user's unique identifier, which the JavaScript will set as the sailthru_hid cookie to identify the user for current and future browsing sessions. This function can be used to easily drop the cookie for known users once your system has identified them (for example, when the user logs in to your site).
This function does not support the optout_email parameter. To opt users back in, instead make a User API call or another method described in the Allowing Users to Opt Back In documentation.

The capabilities of userSignUp can alternatively be performed with the User API.

Alternatively, you can use the userSignUpConfirmedOptIn function, which sends a confirmation email and only adds the user to a specified list after the user clicks a confirmation link within the email.

Usage

Copy

Sailthru.integration("userSignUp",
{
  "email" : "<user id>",
  "lists" : { <list1> : <membership>, <list2> : <membership> },
  "vars" : { <var key and value> },
  "source" : <string>,
  "onSuccess": <response>,
  "onError": <response>});

Parameters

email - Required
lists - Natural lists to add the user. Required if vars or source not specified
- Use key-value pairs, with listName as key.
- Value of 1 to add to the list.
- Value of 0 to remove from the list.
vars - Required if lists or source not specified
source - acquisition source name (e.g. "Facebook campaign") - Optional
onSuccess - JavaScript function that is called on a successful submission - Optional
onError - JavaScript function that is called when the function fails - Optional

Example

Copy

Sailthru.integration("userSignUp", 
{ "email" : "user@example.com",
  "lists" : {
    "Main List" : 1, // list to add user to (must exist in Sailthru account)
    "Anonymous" : 0 // list to remove user from (must exist in Sailthru account)
  },
  "vars" : {
    "sign_up_date" : "2018-08-20",
    "first_name" : "Bob"  },
  "source" : "web",
  "onSuccess" : function() {
    alert('Thank you for signing up for our list');
   },
  "onError" : function() {
    alert('We encountered an issue signing you up. Please try again');
   }
});

GDPR Note To avoid tracking anonymous users who opt-out of anonymous user tracking, delete the sailthru_content cookie, or the sailthru_cid cookie if using older Horizon JS, before making the userSignUp call. That way no anonymous user data is being tracked. Initiate the following JavaScript before the user sign up call:

Copy

document.cookie='sailthru_content=; path=/'

For Horizon JavaScript:

Copy

document.cookie='sailthru_cid=; path=/'

userSignUpConfirmedOptin

Request that an opt-in confirmation email is sent to a user before they are added to a specified list. If the user does not already exist then the user is added to your account. In any case, the user will not be added to the list until they confirm via the link in the confirmation email. Recent pageviews, recorded to a cookie while the user was browsing anonymously, are automatically passed into the function to build the new or existing user's interest profile. In conjunction, you can create Lifecycle Optimizer flow that is initiated when the user finally enters the target list. The capabilities of userSignUpConfirmedOptin can alternatively be performed with the User API.

Usage

Copy

Sailthru.integration("userSignUpConfirmedOptIn", {
   "id" : "<user id>",
   "key" : "<user id type>",
   "source" : "<acquisition source>",
   "template" : {
       "name" : "<confirmed opt-in template name>",
       "vars" : {
           "<var name 1>": "<var value 1>",
           "<var name 2>": "<var value 2>"       },
   "vars" : { "<var name 1>": "<var value 1>" },
   "onSuccess" : <response>,
   "onError" : <response>   }
});

Parameters

email - Required
id - alternate user identifier - Required if email not included
key - type of specified id - Required if email not included; supported keys are email, extid, fb, sms, twitter; for more details, see key details in the User API documentation
name - Confirmed opt-in template to send - Required
vars - Template vars; vars accessible within the opt-in template - Optional
source - acquisition source name (e.g. "Facebook campaign") - Optional
source - acquisition source name (e.g. "Facebook campaign") - Optional
vars - User var names and values to add/update - Optional
onSuccess - JavaScript function that is called on a successful submission - Optional
onError - JavaScript function that is called when the function fails - Optional

Example

Copy

Sailthru.integration('userSignUpConfirmedOptIn', {
    "id" : "user@example.com",
    "key" : "email",
    "source" : "Twitter campaign",
    "template" : {
        "name" : "twitter_welcome",
        "vars" : {
            "name": "Mike",
            "source_tweet": "https://twitter.com/sailthru/status/829425076672069632"        }
    },
    "vars" : {
        "sign_up_date" : "2018-08-20",
        "first_name" : "Mike"    },
    "onSuccess" : function () {
    alert('Thank you for signing up for our list');
    },
    "onError" : function () {
    alert('We encountered an issue signing you up. Please try again');
    }
});

addToCart

Call this function each time a user adds an item to their cart or removes an item from their cart. Each time the cart contents changes, submit an array of all cart items.

Notes:

To remind a user about an abandoned cart, use Lifecycle Optimizer to power an abandoned-cart reminder flow that uses onsite inactivity after the cart addition to trigger the reminder. Both methods are described here. All parameters available for a purchase in the Purchase API are available with this function, as well. Required parameters are email and either URL or SKU.
The email parameter is not required if the sailthru_hid cookie is present on the user profile.

Usage:

JavaScript API Library

userSignUp

userSignUpConfirmedOptin

addToCart

purchase

customEvent

getCurrentUser

gdprDoNotTrack

cookiesDoNotTrack