Home | Userflow Documentation

<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Home | Userflow Documentation</title> <meta property="og:locale" content="en_US" /> <meta property="og:type" content="article" /> <meta property="og:title" content="Home | Userflow Documentation" /> <meta property="og:image" content="https://userflow.com/images/userflow-about-v2.png" /> <meta property="og:image:width" content="1200" /> <meta property="og:image:height" content="630" /> <meta property="og:url" content="https://userflow.com/docs" /> <meta name="twitter:card" content="summary" /> <meta name="twitter:image" content="https://userflow.com/images/userflow-about-v2.png" /> <meta name="twitter:site" content="@getuserflow" /> <meta name="twitter:creator" content="@getuserflow" /> <meta name="twitter:title" content="Home | Userflow Documentation" /> <link rel="shortcut icon" type="image/png" href="/images/favicon.png" /> <link rel="stylesheet" href="https://use.typekit.net/rak3tdq.css" /> <link rel="Stylesheet" href="https://userflow-assets.storage.googleapis.com/assets/site/main.v1.yjG-icXi.css"></link> <link rel="modulepreload" href="https://userflow-assets.storage.googleapis.com/assets/site/main.v1.bHZrzNF-.js"> <script src="https://kit.fontawesome.com/d3dc32f4ba.js" crossorigin="anonymous" nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"></script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe">(function(c,a){if(!a.__SV){var b=window;try{var d,m,j,k=b.location,f=k.hash;d=function(a,b){return(m=a.match(RegExp(b+"=([^&]*)")))?m[1]:null};f&&d(f,"state")&&(j=JSON.parse(decodeURIComponent(d(f,"state"))),"mpeditor"===j.action&&(b.sessionStorage.setItem("_mpcehash",f),history.replaceState(j.desiredHash||"",c.title,k.pathname+k.search)))}catch(n){}var l,h;window.mixpanel=a;a._i=[];a.init=function(b,d,g){function c(b,i){var a=i.split(".");2==a.length&&(b=b[a[0]],i=a[1]);b[i]=function(){b.push([i].concat(Array.prototype.slice.call(arguments, 0)))}}var e=a;"undefined"!==typeof g?e=a[g]=[]:g="mixpanel";e.people=e.people||[];e.toString=function(b){var a="mixpanel";"mixpanel"!==g&&(a+="."+g);b||(a+=" (stub)");return a};e.people.toString=function(){return e.toString(1)+".people (stub)"};l="disable time_event track track_pageview track_links track_forms track_with_groups add_group set_group remove_group register register_once alias unregister identify name_tag set_config reset opt_in_tracking opt_out_tracking has_opted_in_tracking has_opted_out_tracking clear_opt_in_out_tracking start_batch_senders people.set people.set_once people.unset people.increment people.append people.union people.track_charge people.clear_charges people.delete_user people.remove".split(" "); for(h=0;h<l.length;h++)c(e,l[h]);var f="set set_once union unset remove delete".split(" ");e.get_group=function(){function a(c){b[c]=function(){call2_args=arguments;call2=[c].concat(Array.prototype.slice.call(call2_args,0));e.push([d,call2])}}for(var b={},d=["get_group"].concat(Array.prototype.slice.call(arguments,0)),c=0;c<f.length;c++)a(f[c]);return b};a._i.push([b,d,g])};a.__SV=1.2;b=c.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL? MIXPANEL_CUSTOM_LIB_URL:"file:"===c.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";d=c.getElementsByTagName("script")[0];d.parentNode.insertBefore(b,d)}})(document,window.mixpanel||[]); </script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> mixpanel.init("619494a9fdb43c4bb53cff4560b7155a", {batch_requests: true}) mixpanel.track('page_viewed', JSON.parse(atob('eyJwYXRobmFtZSI6Ii9kb2NzIn0='))) </script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> (function (w, d, s, l, i) { w[l] = w[l] || []; w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' }); var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f); })(window, document, 'script', 'dataLayer', 'GTM-5ZL9DTJ'); </script> </head> <body> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5ZL9DTJ" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <div id="root"> <div class="site-header sticky-header"> <div class="site-header__content "> <div class="navbar-container"> <div class="navbar-logo"> <a href="https://userflow.com/"> <svg xmlns="http://www.w3.org/2000/svg" width="500" height="100" fill="none" viewBox="0 0 500 100"> <path class="userflow-logo-fg" fill="#23d777" d="m61.49 30.37-1.652 9.37c-1.762 10-11.293 18-21.244 18h-8.159c-10.011 0-16.628-8.09-14.876-18l3.313-18.77h9.42L24.98 39.74a6.992 6.992 0 0 0 1.405 6.088 7.007 7.007 0 0 0 5.713 2.542h8.16a10.77 10.77 0 0 0 6.58-2.553 10.747 10.747 0 0 0 3.58-6.077L52.9 25.67a5.849 5.849 0 0 1 5.536-4.7h17.43l1.081-6.15C78.4 6.63 72.943 0 64.734 0H24.689C16.499 0 8.67 6.63 7.239 14.82l-7.008 40C-1.21 63 4.236 69.63 12.445 69.63H52.49c8.199 0 16.018-6.63 17.45-14.81l4.314-24.45H61.49Z"/> <path class="userflow-logo-bg" fill="#1a57e6" d="M87.62 30.37h-4.005l-6.097 34.57c-1.442 8.18-9.26 14.82-17.45 14.82h-36.09l-.951 5.43C21.575 93.37 27.03 100 35.24 100h40.045c8.19 0 16.018-6.63 17.45-14.81l7.008-40c1.531-8.18-3.935-14.82-12.124-14.82Z"/> <path class="userflow-logo-txt" fill="#060d37" d="m347.79 3-2.253 13.112h-2.97c-5.94 0-6.864.922-8.197 9.22 0 .102-.203.716-.307 1.229h9.63l-2.253 12.497h-9.527c-2.766 15.57-6.863 38.722-6.863 38.722-2.971 17.414-5.634 22.331-20.693 22.331h-6.863l2.253-13.112h2.971c5.532 0 6.864-.922 8.298-9.22l9.219-52.55C323.205 6.073 327.611 3 343.693 3h4.097ZM129.936 26.56c8.093 0 11.474 4.508 9.322 15.571l-2.765 13.932c-1.332 6.556.717 10.346 6.35 10.346 5.123 0 8.708-5.122 10.142-12.497l5.327-27.351h14.341l-6.556 34.009c-.717 3.688-.102 5.02 3.176 5.02h2.048l-2.15 12.19h-6.66c-5.121 0-8.502-1.435-9.936-5.02-3.175 3.688-7.58 6.044-13.624 6.044-12.395.102-19.975-7.785-17.005-22.946l2.561-11.985c.82-3.995 0-5.122-2.868-5.122H120l2.254-12.19h7.682v-.001Zm65.356 52.244c12.6 0 20.692-6.249 22.229-15.263 1.946-11.371-7.273-14.956-15.059-17.312-5.429-1.64-10.243-2.664-9.731-5.327.41-2.459 2.663-4.098 6.453-4.098 4.713 0 8.298 2.356 10.552 5.737l11.37-7.376c-3.79-5.634-11.473-9.629-21.204-9.629-11.064 0-19.566 5.737-21 14.034-2.049 11.78 7.17 15.161 14.956 17.415 5.429 1.536 10.244 2.56 9.731 5.429-.512 2.97-3.175 4.61-6.863 4.61-5.122 0-9.015-2.766-11.576-7.069l-12.087 7.888c3.483 5.839 10.858 10.96 22.229 10.96v.001Zm233.695-52.243c8.093 0 11.27 4.507 9.116 15.57l-2.766 14.137c-1.33 6.863.31 10.346 5.84 10.346 5.326 0 9.22-5.634 10.653-13.112l4.713-26.941h14.24l-5.43 31.55c-.923 5.635 1.127 8.195 5.02 8.195 8.194 0 12.907-8.707 14.854-19.872 1.636-8.912.51-15.161-1.127-19.873h14.443c1.127 5.224 2.357 12.292.51 22.126-2.763 15.468-11.88 30.117-28.886 30.117-8.194 0-12.704-2.561-14.854-7.273-4.61 4.712-10.653 7.273-17.72 7.273-11.986 0-19.463-8.4-16.596-22.946l2.356-11.985c.82-3.995 0-5.122-2.87-5.122h-1.536l2.256-12.19h7.784Zm-40.77 52.243c15.263 0 25.713-10.346 28.273-23.458 2.867-15.264-6.453-29.81-24.277-29.81-14.65 0-25.713 10.346-28.273 23.458-2.87 15.264 6.453 29.81 24.277 29.81ZM233.468 57.19l.052.118-.044-.016c1.23 5.634 5.737 9.322 12.805 9.322 5.02 0 9.117-2.151 12.395-6.351l10.756 7.068c-5.02 6.863-12.087 11.473-23.97 11.473-18.644 0-27.146-14.649-24.483-29.605 2.327-13.03 13.617-21.916 25.65-23.432a25.133 25.133 0 0 1 3.41-.23h.237c.092 0 .18 0 .265.003 15.372.25 24.59 11.935 22.957 26.528l-.574 5.122h-39.456ZM366.64 3l-10.347 58.594c-.513 2.664.307 3.688 2.97 3.688h1.537l-2.253 12.498h-6.35c-11.474 0-11.68-7.069-10.04-16.288L352.4 3h14.24ZM284 26.56c6.658 0 9.116 3.176 9.526 8.093 3.688-5.531 8.912-8.092 15.366-8.092h6.556l-2.561 14.136h-5.634c-7.069 0-11.986 3.176-13.83 12.702l-4.814 24.38h-14.341l6.556-33.906c.922-3.688 0-5.122-3.278-5.122h-1.64l2.152-12.19h5.941l.001-.001Zm104.933 39.234c-7.99 0-12.803-7.273-11.473-15.16 1.23-7.478 7.683-12.293 14.033-12.293 8.197.205 12.807 7.478 11.474 15.366-1.227 7.478-7.374 12.087-14.034 12.087ZM260.05 45.921c-1.248-5.326-5.343-8.092-11.284-8.092-5.941 0-10.816 3.278-13.506 8.092h24.79Z"/> </svg> </a> </div>  <div class="main-pane desktop-only"> <div class="dropdown-container"> <div class="dropdown-wrapper"> <div class="main-pane-item" style="padding-right: 19px"> <span>Product</span> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">  <path fill="currentColor" d="M233.4 406.6c12.5 12.5 32.8 12.5 45.3 0l192-192c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L256 338.7 86.6 169.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3l192 192z"> </path> </svg> </div> <nav class="dropdown-nav"> <a href=https://userflow.com/product>Product Overview</a> <a href=https://userflow.com/resource-center>Resource Center</a> <a href=https://userflow.com/ai-assistant>AI Assistant</a> <a href=https://userflow.com/in-app-surveys>In-app surveys</a> <a href=https://userflow.com/feature-announcements>Feature announcements</a> </nav> </div> </div> <div class="main-pane-item">Pricing</div> <div class="dropdown-container"> <div class="dropdown-wrapper"> <div class="main-pane-item" style="margin-right: 1px;"> <span>Resources</span> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">  <path fill="currentColor" d="M233.4 406.6c12.5 12.5 32.8 12.5 45.3 0l192-192c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L256 338.7 86.6 169.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3l192 192z"> </path> </svg> </div> <nav class="dropdown-nav"> <a href=https://userflow.com/blog>Blog</a> <a href=https://userflow.com/docs>Documentation</a> <a href=https://userflow.com/customers>Customers</a> <a href=https://userflow.com/best-practices>Best practices</a> <a href=https://userflow.com/docs/dev>Developer docs</a> </nav> </div> </div> <a style="padding-right: 9px;" class="main-pane-icon main-pane-item" href=https://userflow.com/app/sign-in> <svg width="34" height="34" viewBox="0 0 34 34" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M17 17C14.6625 17 12.6615 16.1677 10.9969 14.5031C9.33229 12.8385 8.5 10.8375 8.5 8.5C8.5 6.1625 9.33229 4.16146 10.9969 2.49688C12.6615 0.832292 14.6625 0 17 0C19.3375 0 21.3385 0.832292 23.0031 2.49688C24.6677 4.16146 25.5 6.1625 25.5 8.5C25.5 10.8375 24.6677 12.8385 23.0031 14.5031C21.3385 16.1677 19.3375 17 17 17ZM0 34V28.05C0 26.8458 0.309896 25.7391 0.929688 24.7297C1.54948 23.7203 2.37292 22.95 3.4 22.4188C5.59583 21.3208 7.82708 20.4974 10.0938 19.9484C12.3604 19.3995 14.6625 19.125 17 19.125C19.3375 19.125 21.6396 19.3995 23.9062 19.9484C26.1729 20.4974 28.4042 21.3208 30.6 22.4188C31.6271 22.95 32.4505 23.7203 33.0703 24.7297C33.6901 25.7391 34 26.8458 34 28.05V34H0ZM4.25 29.75H29.75V28.05C29.75 27.6604 29.6526 27.3063 29.4578 26.9875C29.263 26.6688 29.0063 26.4208 28.6875 26.2438C26.775 25.2875 24.8448 24.5703 22.8969 24.0922C20.949 23.6141 18.9833 23.375 17 23.375C15.0167 23.375 13.051 23.6141 11.1031 24.0922C9.15521 24.5703 7.225 25.2875 5.3125 26.2438C4.99375 26.4208 4.73698 26.6688 4.54219 26.9875C4.3474 27.3063 4.25 27.6604 4.25 28.05V29.75ZM17 12.75C18.1688 12.75 19.1693 12.3339 20.0016 11.5016C20.8339 10.6693 21.25 9.66875 21.25 8.5C21.25 7.33125 20.8339 6.33073 20.0016 5.49844C19.1693 4.66615 18.1688 4.25 17 4.25C15.8312 4.25 14.8307 4.66615 13.9984 5.49844C13.1661 6.33073 12.75 7.33125 12.75 8.5C12.75 9.66875 13.1661 10.6693 13.9984 11.5016C14.8307 12.3339 15.8312 12.75 17 12.75Z" fill="#132B39"/> </svg> </a> <div class="action-buttons-container"> <a class="view-demo-button--no-border" href=https://userflow.com/demo#schedule>View a Demo</a> <a class="free-trial-button" href=https://userflow.com/app/create-account>Start Free Trial</a> </div> </div>  <div class="mobile-only"> <a class="free-trial-button mobile-cta" href=https://userflow.com/app/create-account>Start Free Trial</a> <button id="mobile-menu-toggle" class="mobile-menu-toggle"> <div class="hamburger-icon"> <span></span> <span></span> <span></span> </div> </button> </div> </div> </div> </div>  <div id="mobile-menu" class="mobile-menu"> <div class="mobile-menu-content"> <div class="mobile-menu-item-container"> <div class="mobile-menu-item" id="mobile-product-toggle"> <span>Product</span> <span class="chevron-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">  <path fill="currentColor" d="M233.4 406.6c12.5 12.5 32.8 12.5 45.3 0l192-192c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L256 338.7 86.6 169.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3l192 192z"> </path> </svg> </span> </div> <div class="mobile-submenu" id="mobile-product-submenu"> <a href=https://userflow.com/product>Product Overview</a> <a href=https://userflow.com/resource-center>Resource Center</a> <a href=https://userflow.com/ai-assistant>AI Assistant</a> <a href=https://userflow.com/in-app-surveys>In-app surveys</a> <a href=https://userflow.com/feature-announcements>Feature announcements</a> </div> </div> <a class="mobile-menu-item" href=https://userflow.com/pricing >Pricing</a> <div class="mobile-menu-item-container"> <div class="mobile-menu-item" id="mobile-resources-toggle"> <span>Resources</span> <span class="chevron-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">  <path fill="currentColor" d="M233.4 406.6c12.5 12.5 32.8 12.5 45.3 0l192-192c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L256 338.7 86.6 169.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3l192 192z"> </path> </svg> </span> </div> <div class="mobile-submenu" id="mobile-resources-submenu"> <a href=https://userflow.com/blog>Blog</a> <a href=https://userflow.com/docs>Documentation</a> <a href=https://userflow.com/customers>Customers</a> <a href=https://userflow.com/best-practices>Best practices</a> <a href=https://userflow.com/docs/dev>Developer docs</a> </div> </div> <a class="mobile-login-button" href=https://userflow.com/app/sign-in > <span class="mobile-menu-icon"><svg width="34" height="34" viewBox="0 0 34 34" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M17 17C14.6625 17 12.6615 16.1677 10.9969 14.5031C9.33229 12.8385 8.5 10.8375 8.5 8.5C8.5 6.1625 9.33229 4.16146 10.9969 2.49688C12.6615 0.832292 14.6625 0 17 0C19.3375 0 21.3385 0.832292 23.0031 2.49688C24.6677 4.16146 25.5 6.1625 25.5 8.5C25.5 10.8375 24.6677 12.8385 23.0031 14.5031C21.3385 16.1677 19.3375 17 17 17ZM0 34V28.05C0 26.8458 0.309896 25.7391 0.929688 24.7297C1.54948 23.7203 2.37292 22.95 3.4 22.4188C5.59583 21.3208 7.82708 20.4974 10.0938 19.9484C12.3604 19.3995 14.6625 19.125 17 19.125C19.3375 19.125 21.6396 19.3995 23.9062 19.9484C26.1729 20.4974 28.4042 21.3208 30.6 22.4188C31.6271 22.95 32.4505 23.7203 33.0703 24.7297C33.6901 25.7391 34 26.8458 34 28.05V34H0ZM4.25 29.75H29.75V28.05C29.75 27.6604 29.6526 27.3063 29.4578 26.9875C29.263 26.6688 29.0063 26.4208 28.6875 26.2438C26.775 25.2875 24.8448 24.5703 22.8969 24.0922C20.949 23.6141 18.9833 23.375 17 23.375C15.0167 23.375 13.051 23.6141 11.1031 24.0922C9.15521 24.5703 7.225 25.2875 5.3125 26.2438C4.99375 26.4208 4.73698 26.6688 4.54219 26.9875C4.3474 27.3063 4.25 27.6604 4.25 28.05V29.75ZM17 12.75C18.1688 12.75 19.1693 12.3339 20.0016 11.5016C20.8339 10.6693 21.25 9.66875 21.25 8.5C21.25 7.33125 20.8339 6.33073 20.0016 5.49844C19.1693 4.66615 18.1688 4.25 17 4.25C15.8312 4.25 14.8307 4.66615 13.9984 5.49844C13.1661 6.33073 12.75 7.33125 12.75 8.5C12.75 9.66875 13.1661 10.6693 13.9984 11.5016C14.8307 12.3339 15.8312 12.75 17 12.75Z" fill="#132B39"/> </svg></span> </a> <div class="mobile-buttons"> <a class="view-demo-button--no-border" href=https://userflow.com/demo#schedule>View a Demo</a> <a style="padding:0 1.25rem !important" class="free-trial-button" href=https://userflow.com/app/create-account>Start Free Trial</a> </div> </div> </div> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> document.addEventListener('DOMContentLoaded', function() { var menuToggle = document.getElementById('mobile-menu-toggle'); var mobileMenu = document.getElementById('mobile-menu'); var productToggle = document.getElementById('mobile-product-toggle'); var productSubmenu = document.getElementById('mobile-product-submenu'); var resourcesToggle = document.getElementById('mobile-resources-toggle'); var resourcesSubmenu = document.getElementById('mobile-resources-submenu'); // Hide submenus initially if (productSubmenu) productSubmenu.style.display = 'none'; if (resourcesSubmenu) resourcesSubmenu.style.display = 'none'; if (menuToggle && mobileMenu) { menuToggle.addEventListener('click', function() { if (mobileMenu.style.display === 'block') { mobileMenu.style.display = 'none'; menuToggle.classList.remove('active'); } else { mobileMenu.style.display = 'block'; menuToggle.classList.add('active'); } }); } if (productToggle && productSubmenu) { productToggle.addEventListener('click', function(e) { e.preventDefault(); if (productSubmenu.style.display === 'block') { productSubmenu.style.opacity = '0'; setTimeout(function() { productSubmenu.style.display = 'none'; }, 300); productToggle.classList.remove('open'); } else { productSubmenu.style.display = 'block'; setTimeout(function() { productSubmenu.style.opacity = '1'; }, 10); productToggle.classList.add('open'); // Close other submenu if open if (resourcesSubmenu.style.display === 'block') { resourcesSubmenu.style.opacity = '0'; setTimeout(function() { resourcesSubmenu.style.display = 'none'; }, 300); resourcesToggle.classList.remove('open'); } } }); } if (resourcesToggle && resourcesSubmenu) { resourcesToggle.addEventListener('click', function(e) { e.preventDefault(); if (resourcesSubmenu.style.display === 'block') { resourcesSubmenu.style.opacity = '0'; setTimeout(function() { resourcesSubmenu.style.display = 'none'; }, 300); resourcesToggle.classList.remove('open'); } else { resourcesSubmenu.style.display = 'block'; setTimeout(function() { resourcesSubmenu.style.opacity = '1'; }, 10); resourcesToggle.classList.add('open'); // Close other submenu if open if (productSubmenu.style.display === 'block') { productSubmenu.style.opacity = '0'; setTimeout(function() { productSubmenu.style.display = 'none'; }, 300); productToggle.classList.remove('open'); } } }); } }); </script> <div class="docs__page"> <div class="docs__page-fill-before"></div> <div class="docs__page-nav-header"> <button class="btn btn--plain docs__page-nav-menu-button"> <i class="far fa-bars"></i> <span class="btn__text-after">Documentation Menu</span> </button> </div> <ul class="docs__page-nav"> <li class="docs__page-nav-node docs__page-nav-node--level-1"> <a href="/docs" class="docs__page-nav-link docs__page-nav-link--level-1 docs__page-nav-link--active"> <span class="docs__page-nav-icon"> <i class="fad fa-home"></i> </span>Home </a> <ul class="docs__page-nav-children docs__page-nav-children--level-1"> <li class="docs__page-nav-node docs__page-nav-node--level-2"> <a href="/docs/guides" class="docs__page-nav-link docs__page-nav-link--level-2"> <span class="docs__page-nav-icon"> <i class="fad fa-route"></i> </span>How-to guides </a> </li> <li class="docs__page-nav-node docs__page-nav-node--level-2"> <a href="/docs/trouble" class="docs__page-nav-link docs__page-nav-link--level-2"> <span class="docs__page-nav-icon"> <i class="fad fa-life-ring"></i> </span>Troubleshooting </a> </li> <li class="docs__page-nav-node docs__page-nav-node--level-2"> <a href="/docs/integrations" class="docs__page-nav-link docs__page-nav-link--level-2"> <span class="docs__page-nav-icon"> <i class="fad fa-exchange-alt"></i> </span>Integrations </a> </li> <li class="docs__page-nav-node docs__page-nav-node--level-2"> <a href="/docs/dev" class="docs__page-nav-link docs__page-nav-link--level-2"> <span class="docs__page-nav-icon"> <i class="fad fa-code"></i> </span>Developers </a> </li> </ul> </li> </ul> <div class="article-content docs__page-content"> <h1 id="userflow-documentation">Userflow Documentation</h1> <p> Userflow is an easy-to-use - yet powerful - user onboarding software.</p> <p> Using our Flow Builder, you can build in-app flows such as:</p> <ul> <li> Onboarding guides </li> <li> Product tours </li> <li> Feature announcements </li> <li> Checklists </li> </ul> <p> Pick a topic in the left menu to learn more.</p> <ul> <li> A great place to start is the guide for building <a href="/docs/guides/onboarding-setup">your first onboarding setup</a> </li> <li> If you are a developer, check out <a href="/docs/dev/userflow-js-installation">the Userflow.js installation guide</a> </li> </ul> <div class="docs__page-contact"> <h3 class="mb-32">Got questions? We're here for you!</h3> <div class="contact__methods"> <div class="contact__method"> <div class="contact__method-icon"> <i class="fal fa-comment-dots"></i> </div> <div class="contact__method-line1"> The best way to get help is to <button class="link-button" data-show-intercom-new-message-onclick> start a chat </button> </div> <div class="contact__method-line2"> We usually reply within 5 minutes </div> </div> <div class="contact__method"> <div class="contact__method-icon"> <i class="fal fa-at"></i> </div> <div class="contact__method-line1"> You can also send an email to <a class="link-button" href="mailto:support@userflow.com"> support@userflow.com </a> </div> <div class="contact__method-line2"> We usually reply within a few hours </div> </div> </div> </div> </div> <div class="docs__page-fill-after"></div> </div> <div class="site-footer"> <div class="site-footer__logos"> <div class="site-footer__logo"> <svg xmlns="http://www.w3.org/2000/svg" width="500" height="100" fill="none" viewBox="0 0 500 100"> <path fill="#23d777" d="m61.49 30.37-1.652 9.37c-1.762 10-11.293 18-21.244 18h-8.159c-10.011 0-16.628-8.09-14.876-18l3.313-18.77h9.42L24.98 39.74a6.992 6.992 0 0 0 1.405 6.088 7.007 7.007 0 0 0 5.713 2.542h8.16a10.77 10.77 0 0 0 6.58-2.553 10.747 10.747 0 0 0 3.58-6.077L52.9 25.67a5.849 5.849 0 0 1 5.536-4.7h17.43l1.081-6.15C78.4 6.63 72.943 0 64.734 0H24.689C16.499 0 8.67 6.63 7.239 14.82l-7.008 40C-1.21 63 4.236 69.63 12.445 69.63H52.49c8.199 0 16.018-6.63 17.45-14.81l4.314-24.45H61.49Z"/> <path fill="#1a57e6" d="M87.62 30.37h-4.005l-6.097 34.57c-1.442 8.18-9.26 14.82-17.45 14.82h-36.09l-.951 5.43C21.575 93.37 27.03 100 35.24 100h40.045c8.19 0 16.018-6.63 17.45-14.81l7.008-40c1.531-8.18-3.935-14.82-12.124-14.82Z"/> <path fill="#fff" d="m347.79 3-2.253 13.112h-2.97c-5.94 0-6.864.922-8.197 9.22 0 .102-.203.716-.307 1.229h9.63l-2.253 12.497h-9.527c-2.766 15.57-6.863 38.722-6.863 38.722-2.971 17.414-5.634 22.331-20.693 22.331h-6.863l2.253-13.112h2.971c5.532 0 6.864-.922 8.298-9.22l9.219-52.55C323.205 6.073 327.611 3 343.693 3h4.097ZM129.936 26.56c8.093 0 11.474 4.508 9.322 15.571l-2.765 13.932c-1.332 6.556.717 10.346 6.35 10.346 5.123 0 8.708-5.122 10.142-12.497l5.327-27.351h14.341l-6.556 34.009c-.717 3.688-.102 5.02 3.176 5.02h2.048l-2.15 12.19h-6.66c-5.121 0-8.502-1.435-9.936-5.02-3.175 3.688-7.58 6.044-13.624 6.044-12.395.102-19.975-7.785-17.005-22.946l2.561-11.985c.82-3.995 0-5.122-2.868-5.122H120l2.254-12.19h7.682v-.001Zm65.356 52.244c12.6 0 20.692-6.249 22.229-15.263 1.946-11.371-7.273-14.956-15.059-17.312-5.429-1.64-10.243-2.664-9.731-5.327.41-2.459 2.663-4.098 6.453-4.098 4.713 0 8.298 2.356 10.552 5.737l11.37-7.376c-3.79-5.634-11.473-9.629-21.204-9.629-11.064 0-19.566 5.737-21 14.034-2.049 11.78 7.17 15.161 14.956 17.415 5.429 1.536 10.244 2.56 9.731 5.429-.512 2.97-3.175 4.61-6.863 4.61-5.122 0-9.015-2.766-11.576-7.069l-12.087 7.888c3.483 5.839 10.858 10.96 22.229 10.96v.001Zm233.695-52.243c8.093 0 11.27 4.507 9.116 15.57l-2.766 14.137c-1.33 6.863.31 10.346 5.84 10.346 5.326 0 9.22-5.634 10.653-13.112l4.713-26.941h14.24l-5.43 31.55c-.923 5.635 1.127 8.195 5.02 8.195 8.194 0 12.907-8.707 14.854-19.872 1.636-8.912.51-15.161-1.127-19.873h14.443c1.127 5.224 2.357 12.292.51 22.126-2.763 15.468-11.88 30.117-28.886 30.117-8.194 0-12.704-2.561-14.854-7.273-4.61 4.712-10.653 7.273-17.72 7.273-11.986 0-19.463-8.4-16.596-22.946l2.356-11.985c.82-3.995 0-5.122-2.87-5.122h-1.536l2.256-12.19h7.784Zm-40.77 52.243c15.263 0 25.713-10.346 28.273-23.458 2.867-15.264-6.453-29.81-24.277-29.81-14.65 0-25.713 10.346-28.273 23.458-2.87 15.264 6.453 29.81 24.277 29.81ZM233.468 57.19l.052.118-.044-.016c1.23 5.634 5.737 9.322 12.805 9.322 5.02 0 9.117-2.151 12.395-6.351l10.756 7.068c-5.02 6.863-12.087 11.473-23.97 11.473-18.644 0-27.146-14.649-24.483-29.605 2.327-13.03 13.617-21.916 25.65-23.432a25.133 25.133 0 0 1 3.41-.23h.237c.092 0 .18 0 .265.003 15.372.25 24.59 11.935 22.957 26.528l-.574 5.122h-39.456ZM366.64 3l-10.347 58.594c-.513 2.664.307 3.688 2.97 3.688h1.537l-2.253 12.498h-6.35c-11.474 0-11.68-7.069-10.04-16.288L352.4 3h14.24ZM284 26.56c6.658 0 9.116 3.176 9.526 8.093 3.688-5.531 8.912-8.092 15.366-8.092h6.556l-2.561 14.136h-5.634c-7.069 0-11.986 3.176-13.83 12.702l-4.814 24.38h-14.341l6.556-33.906c.922-3.688 0-5.122-3.278-5.122h-1.64l2.152-12.19h5.941l.001-.001Zm104.933 39.234c-7.99 0-12.803-7.273-11.473-15.16 1.23-7.478 7.683-12.293 14.033-12.293 8.197.205 12.807 7.478 11.474 15.366-1.227 7.478-7.374 12.087-14.034 12.087ZM260.05 45.921c-1.248-5.326-5.343-8.092-11.284-8.092-5.941 0-10.816 3.278-13.506 8.092h24.79Z"/> </svg> </div> </div> <ul class="site-footer__menu"> <li class="site-footer__menu-group"> <div class="site-footer__menu-header">Product</div> <ul> <li> <a href=https://userflow.com/product> Product overview </a> </li> <li> <a href=https://userflow.com/resource-center> Resource Center </a> </li> <li> <a href=https://userflow.com/ai-assistant> AI Assistant </a> </li> <li> <a href=https://userflow.com/in-app-surveys> In-app surveys </a> </li> <li> <a href=https://userflow.com/feature-announcements> Feature announcements </a> </li> <li> <a href=https://userflow.com/pricing> Pricing </a> </li> <li> <a href=https://userflow.com/alternatives> Alternatives </a> </li> </ul> </li> <li class="site-footer__menu-group"> <div class="site-footer__menu-header">Solutions</div> <ul> <li> <a href=https://userflow.com/user-onboarding> User onboarding </a> </li> <li> <a href=https://userflow.com/product-tours> Product tours </a> </li> <li> <a href=https://userflow.com/product-led-growth> Product-led growth </a> </li> <li> <a href=https://userflow.com/customer-self-service> Customer self-service </a> </li> <li> <a href=https://userflow.com/trial-conversion> Trial conversion </a> </li> </ul> <div class="site-footer__menu-header">Developers</div> <ul> <li> <a href=/docs/dev> Developer docs </a> </li> <li> <a href=/docs/dev/userflow-js-installation> Userflow.js Installation </a> </li> <li> <a href=/docs/userflow-js> Userflow.js Reference </a> </li> <li> <a href=/docs/api>API Reference</a> </li> </ul> </li> <li class="site-footer__menu-group"> <div class="site-footer__menu-header">Resources</div> <ul> <li> <a href=https://userflow.com/blog> Blog </a> </li> <li> <a href=https://userflow.com/customers> Customers </a> </li> <li> <a href=/docs> Documentation </a> </li> <li> <a href=https://userflow.com/first-userflow-onboarding> First Userflow onboarding </a> </li> <li> <a href=https://userflow.com/userflow-tips-and-tricks> Userflow tips and tricks </a> </li> <li> <a href=https://userflow.com/onboarding-best-practices> Onboarding best practices </a> </li> <li> <a href=https://userflow.com/resource-center-best-practices> Resource center best practices </a> </li> <li> <a href=https://userflow.com/product-led-at-userflow> Product-led at Userflow </a> </li> </ul> </li> <li class="site-footer__menu-group"> <ul> <li style="margin-bottom: 12px;"> <a class="free-trial-button" href=https://userflow.com/app/create-account>Start Free Trial</a> </li> <li> <a class="view-demo-button" href=https://userflow.com/demo#schedule>View a Demo</a> </li> </ul> <div class="site-footer__menu-header">漏 Userflow Inc. 2025</div> <ul> <li> <a href="https://status.userflow.com"> System status </a> </li> <li> <a href=https://userflow.com/policies/security> Security </a> </li> <li> <a href=https://userflow.com/policies/privacy-regulations> Privacy Regulations (GDPR) </a> </li> <li> <a href=https://userflow.com/policies/terms> Terms of Service </a> </li> <li> <a href=https://userflow.com/policies/privacy> Privacy Policy </a> </li> <li> <a href=https://userflow.com/policies> All policies </a> </li> </ul> </li> </ul> <div class="site-footer__logos mb-64"> <div class="site-footer__soc2"> <img src="/images/policies/soc2.png"/> </div> </div> </div> </div> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> var USERFLOW_ENV_VARS = {} </script> <script type="module" src="https://userflow-assets.storage.googleapis.com/assets/site/main.v1.bHZrzNF-.js" nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"></script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> !function(){var e="undefined"==typeof window?{}:window,t=e.userflow,r=e.history;function n(t,n){return function(){var o=new CustomEvent(n),s=Array.prototype.slice.call(arguments),a=t.apply(r,s);return e.dispatchEvent(o),a}}if(r){e.__userflowStatePatched=!0;var o=r.pushState,s=r.replaceState;r.pushState=n(o,"userflow:pushstate"),r.replaceState=n(s,"userflow:replacestate")}if(!t){var a="https://js.userflow.com/",l=null;t=e.userflow={_stubbed:!0,load:function(){return l||(l=new Promise((function(t,r){var n=document.createElement("script");n.async=!0;var o=e.USERFLOWJS_ENV_VARS||{};"es2020"===(o.USERFLOWJS_BROWSER_TARGET||function(e){for(var t=[[/Edg\//,/Edg\/(\d+)/,80],[/OPR\//,/OPR\/(\d+)/,67],[/Chrome\//,/Chrome\/(\d+)/,80],[/CriOS\//,/CriOS\/(\d+)/,100],[/Safari\//,/Version\/(\d+)/,14],[/Firefox\//,/Firefox\/(\d+)/,74]],r=0;r<t.length;r++){var n=t[r],o=n[0],s=n[1],a=n[2];if(e.match(o)){var l=e.match(new RegExp(s));if(l&&parseInt(l[1],10)>=a)return"es2020";break}}return"legacy"}(navigator.userAgent))?(n.type="module",n.src=o.USERFLOWJS_ES2020_URL||a+"es2020/userflow.js"):n.src=o.USERFLOWJS_LEGACY_URL||a+"legacy/userflow.js",n.onload=function(){t()},n.onerror=function(){document.head.removeChild(n),l=null;var e=new Error("Could not load Userflow.js");console.warn(e.message),r(e)},document.head.appendChild(n)}))),l}};var u=e.USERFLOWJS_QUEUE=e.USERFLOWJS_QUEUE||[],i=function(e){t[e]=function(){var r=Array.prototype.slice.call(arguments);t.load(),u.push([e,null,r])}},c=function(e){t[e]=function(){var r,n=Array.prototype.slice.call(arguments);t.load();var o=new Promise((function(e,t){r={resolve:e,reject:t}}));return u.push([e,r,n]),o}},d=function(e,r){t[e]=function(){return r}};i("_setTargetEnv"),i("closeResourceCenter"),i("disableEvalJs"),i("init"),i("off"),i("on"),i("prepareAudio"),i("registerCustomInput"),i("remount"),i("reset"),i("setBaseZIndex"),i("setCustomInputSelector"),i("setCustomNavigate"),i("setCustomScrollIntoView"),i("setInferenceAttributeFilter"),i("setInferenceAttributeNames"),i("setInferenceClassNameFilter"),i("setResourceCenterLauncherHidden"),i("setScrollPadding"),i("setServerEndpoint"),i("setShadowDomEnabled"),i("setPageTrackingDisabled"),i("setUrlFilter"),i("setLinkUrlDecorator"),i("openResourceCenter"),i("toggleResourceCenter"),c("endAll"),c("endAllFlows"),c("endChecklist"),c("group"),c("identify"),c("identifyAnonymous"),c("start"),c("startFlow"),c("startWalk"),c("track"),c("updateGroup"),c("updateUser"),d("getResourceCenterState",null),d("isIdentified",!1)}}(); userflow.init('evao4c7wsve27lu324gtqrtfia') userflow.identify( 'visitor-7d46393d-5975-4fa4-871c-73d8ba92bd6e', { user_type: 'visitor' }, { signature: '2b73b7749fed8d32ef3edc80267e8a3cef91e20bb389790d91329da4e05da8fd' } ) </script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> window.intercomSettings = { app_id: "yq7qhyvw", hide_default_launcher: true }; </script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe"> (function () { var w = window; var ic = w.Intercom; if (typeof ic === "function") { ic('reattach_activator'); ic('update', w.intercomSettings); } else { var d = document; var i = function () { i.c(arguments); }; i.q = []; i.c = function (args) { i.q.push(args); }; w.Intercom = i; var l = function () { var s = d.createElement('script'); s.type = 'text/javascript'; s.async = true; s.src = 'https://widget.intercom.io/widget/yq7qhyvw'; var x = d.getElementsByTagName('script')[0]; x.parentNode.insertBefore(s, x); }; if (w.attachEvent) { w.attachEvent('onload', l); } else { w.addEventListener('load', l, false); } } })(); </script> <script nonce="86644de1-e7e3-4137-84ff-3a86da5c11fe" type="text/javascript" id="hs-script-loader" async defer src='//js.hs-scripts.com/9255119.js'></script> </body> </html>

CINXE.COM

Home | Userflow Documentation