Userflow.js Installation
Before your users can see the flows and other content you build, you need to install Userflow.js in your web app.
Userflow.js is a tiny piece of JavaScript code (~15 kB), which is loaded asynchronously in your web app, so it won’t affect your page load speed.
The installation is simple and only requires 3 quick steps:
- Step 1: Choose installation method
- Step 2: Install Userflow.js
- Step 3: Replace placeholders
- Optional: Add custom attributes
- Optional: Enforce identity verification
- Optional: Install Userflow for unauthenticated users
Step 1: Choose installation method
Userflow.js can be installed in one of 2 ways:
-
Browser apps using module bundlers (such as Webpack or Rollup)
- Go to Step 2A (npm installation)
-
Other browser apps and Google Tag Manager
- Go to Step 2B (HTML snippet installation)
We also have specific instructions for special apps/tools:
Step 2A: npm installation
We recommend installing Userflow.js using the userflow.js npm package.
First, run this in your Terminal:
npm install userflow.js
Import and use the userflow object from the userflow.js module:
import userflow from 'userflow.js'
userflow.init('USERFLOW_TOKEN')
userflow.identify('USER_ID', {
name: 'USER_NAME',
email: 'USER_EMAIL',
signed_up_at: 'USER_SIGNED_UP_AT'
})
Important: Make sure to replace the RED placeholders with real, dynamic values from your app! See Step 3.
Step 2B: HTML snippet installation
Only do this if you did not complete Step 2A.
Copy-paste the following snippet into your HTML document before the ending </body> tag:
<script>
!function(){var e="undefined"==typeof window?{}:window,r=e.userflow;if(!r){var t="https://js.userflow.com/",n=null;r=e.userflow={_stubbed:!0,load:function(){return n||(n=new Promise((function(r,o){var s=document.createElement("script");s.async=!0;var a=e.USERFLOWJS_ENV_VARS||{};"es2020"===(a.USERFLOWJS_BROWSER_TARGET||function(e){for(var r=[[/Edg\//,/Edg\/(\d+)/,80],[/OPR\//,/OPR\/(\d+)/,67],[/Chrome\//,/Chrome\/(\d+)/,80],[/CriOS\//,/CriOS\/(\d+)/,100],[/Safari\//,/Version\/(\d+)/,14],[/Firefox\//,/Firefox\/(\d+)/,74]],t=0;t<r.length;t++){var n=r[t],o=n[0],s=n[1],a=n[2];if(e.match(o)){var u=e.match(new RegExp(s));if(u&&parseInt(u[1],10)>=a)return"es2020";break}}return"legacy"}(navigator.userAgent))?(s.type="module",s.src=a.USERFLOWJS_ES2020_URL||t+"es2020/userflow.js"):s.src=a.USERFLOWJS_LEGACY_URL||t+"legacy/userflow.js",s.onload=function(){r()},s.onerror=function(){document.head.removeChild(s),n=null;var e=new Error("Could not load Userflow.js");console.error(e.message),o(e)},document.head.appendChild(s)}))),n}};var o=e.USERFLOWJS_QUEUE=e.USERFLOWJS_QUEUE||[],s=function(e){r[e]=function(){var t=Array.prototype.slice.call(arguments);r.load(),o.push([e,null,t])}},a=function(e){r[e]=function(){var t,n=Array.prototype.slice.call(arguments);r.load();var s=new Promise((function(e,r){t={resolve:e,reject:r}}));return o.push([e,t,n]),s}},u=function(e,t){r[e]=function(){return t}};s("_setTargetEnv"),s("closeResourceCenter"),s("init"),s("off"),s("on"),s("prepareAudio"),s("registerCustomInput"),s("remount"),s("reset"),s("setBaseZIndex"),s("setCustomInputSelector"),s("setCustomNavigate"),s("setCustomScrollIntoView"),s("setInferenceAttributeFilter"),s("setInferenceAttributeNames"),s("setInferenceClassNameFilter"),s("setResourceCenterLauncherHidden"),s("setScrollPadding"),s("setServerEndpoint"),s("setShadowDomEnabled"),s("setPageTrackingDisabled"),s("setUrlFilter"),s("openResourceCenter"),s("toggleResourceCenter"),a("endAll"),a("endAllFlows"),a("endChecklist"),a("group"),a("identify"),a("identifyAnonymous"),a("start"),a("startFlow"),a("startWalk"),a("track"),a("updateGroup"),a("updateUser"),u("getResourceCenterState",null),u("isIdentified",!1)}}();
userflow.init('USERFLOW_TOKEN')
userflow.identify('USER_ID', {
name: 'USER_NAME',
email: 'USER_EMAIL',
signed_up_at: 'USER_SIGNED_UP_AT'
})
</script>
Important: Make sure to replace the RED placeholders with real, dynamic values from your app! See Step 3.
Step 3: Replace placeholders
In the code you copy-pasted above, replace USERFLOW_TOKEN with the Userflow.js Token you find under Settings -> Environments. Note that if you have multiple environments (e.g. Production and Staging) that each environment has a unique token.
Next, replace USER_ID with the currently signed in user’s ID in your database. Also replace USER_NAME, USER_EMAIL and USER_SIGNED_UP_AT with the user’s real, dynamic values. signed_up_at should be specified in ISO 8601 format. Example: 2019-12-11T12:34:56Z.
The properties in userflow.identify()‘s second argument are all optional. They’re useful for looking up users in Userflow to e.g. see their flow progress, or to use in the flow content or conditions. If you don’t want to share this with Userflow, feel free to leave out the argument completely.
That’s it! Your Userflow installation is ready.
Optional: Add custom attributes
Userflow.js supports sending custom attributes: Key-value pairs of data such as user role or other preferences. See Userflow.js Reference for how to use attributes.
Optional: Enforce identity verification
Identity verification is a Userflow security feature that prevents malicious third parties from impersonating your users.
We strongly recommend that you configure and enforce identity verification to safe-guard your users’ information.
See the identity verification guide
Optional: Install Userflow for uauthenticated users
Running userflow.identify() is a mandatory part of the script. But if you want to show Userflow content on public pages to users who are not yet signed into your application, you can install the script on those pages and replace userflow.identify() with userflow.identifyAnonymous(). With this function Userflow.js will automatically assign the current user a unique ID. But note that they will count as users in the MAU balance.
See userflow.identifyAnonymous() docs
