Articles
Requirements and Guidelines
To ensure that Userlane will run smoothly on your application, follow these guidelines as much as possible. Must The underlying app needs to run with an encrypted protocol (HTTPS) to ensure a secure and encrypted communication. The underlyin...
Quick reference of commands in Userlane
Here you will find a quick reference list of all our supported Userlane commands. Click on any header for more information. Load the script // load Userlane
(function(i,s,o,g,r,a,m){i['UserlaneCommandObject']=r;i[r]=i[r]||function(){...
Implement a command to open the Assistant
Usually, a user opens the Assistant by clicking the Assistant icon (avatar) that is visible in one corner of the screen. In some cases you might want to decide by whom and where Userlane content should be seen and want to show Userlane only w...
Hide Userlane on specific pages of your application
In some cases you might want to decide by whom and where Userlane content should be seen. In this article we are outlining various options on how this can be achieved. Why use it? You might want to Hide the Userlane Assistant on dedica...
lang - Define your language detection
Userlane automatically detects the language of your application and of the user's browser to match a user's language preferences. If you want to make sure that Userlane always uses the same language as your application, you can explicitly d...
start, startOnce - Trigger a Guide in your code
Why use it Start a Guide with a custom trigger natively in your application. You can use the trigger command to start a Guide, e.g. within a specific button. ℹ️ Please note that commands play the Guide and do not take any Segmentation set...
onStart, onComplete, onExit - Event callbacks
Hook into Userlane Events to create custom reactions or implementations. The Userlane Javascript API provides some events that you can hook into. This allows you to get notified when a user does something within Userlane. There are three events th...
User event export
The API user event export allows you to retrieve data containing the events (interactions) a User had with your Guides.
User profile data export
This end-user data export allows you to see details of your Userlane users, like time last seen or the attributes.