Quick reference of commands in Userlane

Click on any header to get redirected to an article outlining the command in more depth.

Load the script

// load Userlane
(function(i,s,o,g,r,a,m){i['UserlaneCommandObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)};a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','https://cdn.userlane.com/userlane.js','Userlane');

Identify your user

//identify command
Userlane('identify', currentUser.id);

Identify the user and pass Custom Attributes

// identify command with custom user attributes
Userlane('identify', currentUser.id, {
  attribute_key: 'attribute_value'
});

Initialize Userlane

// initialize command
Userlane('init', your_property_ID);

Open the Userlane Assistant

// open the Userlane Assistant  
Userlane('openAssistant');

Hide the Userlane Assistant

// hide Userlane
Userlane('hide');

// show Userlane again with initializing it
Userlane('init', your_property_ID);

Language command

// set the language of Userlane
Userlane('lang', 'language_code');

Trigger command

// Start a userlane
// TODO: replace 12345 with your userlane id
Userlane('start', 12345); 

// Start a userlane at a specific step
// TODO: replace 12345 with your userlane id
// TODO: replace 4 with the index of the step
Userlane('start', 12345, 4);

//Start a userlane only once per User
// TODO: replace 12345 with your userlane id
Userlane('startOnce', 12345);

Callback events

// hook into onStart, onComplete or onExit and provide a callback function
//TODO: Optionally replace onStart with onComplete or onExit and adjust the respective output message
Userlane('onStart', function(userlaneId, user) {

// you can put any code in here

console.log('the user started a guide');
});

// remove all callbacks from the onStart event
Userlane('onStart', false);

//Example user object you receive:
{
id: "9717166719265375",
generated: true,
time_signup: "2017-11-22T11:50:48.671Z"
}