Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.
Trusted by thousands of product and customer teams, Userpilot is a product growth platform that empowers non-technical teams to create and optimize user onboarding, drive feature adoption, and boost customer retention across web and mobile, without writing a single line of code.
Deliver contextual, in-app experiences that guide users to their βaha!β
moments faster with flows, tooltips, banners, and checklists. Reduce
time-to-value and increase activation rates.
Encourage users to explore new or underutilized features with targeted
in-app messages and interactive walkthroughs. Increase feature adoption and
user engagement.
Keep users engaged and help them build habits with segmentation, surveys,
emails, and data-backed insights. Reduce churn and increase customer lifetime value.
Segment users based on activity or milestones
Send in-app surveys and emails to capture feedback
Track custom events, analyze flow performance, and correlate actions with
engagement metrics. Make data-driven decisions to optimize your product
experience across web and mobile.
Start by installing Userpilot on your application, then create your first flow using the Chrome Extension. Check out our quickstart guide for step-by-step instructions.
What's the difference between flows, spotlights, and banners?
Spotlights: Highlight specific elements on your page
Banners: Display messages at the top or bottom of the page
Can I use Userpilot on mobile apps?
Yes! Userpilot supports both iOS and Android applications. Check out our mobile installation guide for setup instructions.
How does Userpilot pricing work?
Userpilot pricing is based on monthly active users (MAU). You can install Userpilot on as many applications and domains as you want. Contact our sales team for detailed pricing information.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Userpilot Knowledge Base","colors":{"primary":"#6765e8","light":"#9a98f0","dark":"#343374"},"logo":{"light":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-dark.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=ed5988b05e17770537d7327506be349c","dark":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-light.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=2558daac7455ff6275b45a01cecb8ca9"},"favicon":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-favicon.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=bd3fb42ae91a32d13d543fed45a8b88e","footer":{"socials":{"twitter":"https://linkedin.com/company/teamuserpilot","facebook":"https://facebook.com/userpilot","linkedin":"https://linkedin.com/company/teamuserpilot"},"links":[{"header":"Support","items":[{"label":"support@userpilot.com","href":"mailto:support@userpilot.com"}]}]},"seo":{"metatags":{"canonical":"https://docs.userpilot.com","og:site_name":"Userpilot Knowledge Base","og:type":"website","og:image":"https://docs.userpilot.com/up-logo-dark.svg","twitter:card":"summary_large_image","twitter:site":"@usaborpilot"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"userpilot","hasAudioNarration":false,"actualSubdomain":"userpilot","customDomains":["docs.userpilot.com"],"gitSource":{"type":"github","owner":"userpilot","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad8e86e35c96ca2475d30c7","collectionId":"f1c52587-1f94-4cdb-a72a-6504f93d775b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad8e86e35c96ca2475d30c7"},"feedback":{"edits":true,"issues":true,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad8e86e35c96ca2475d30c7","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Platform","count":137},{"language":"default","tag":"Developer","count":88},{"language":"default","tag":"Installation","count":76},{"language":"default","tag":"Mobile","count":68},{"language":"default","tag":"In App Engagement","count":56},{"language":"default","tag":"APIs","count":42},{"language":"default","tag":"Configure","count":23},{"language":"default","tag":"Endpoints","count":20},{"language":"default","tag":"Bulk Export","count":17},{"language":"default","tag":"Integrations","count":14}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--primary:103 101 232;--primary-light:225 224 250;--primary-dark:103 101 232;--background-light:255 255 255;--background-dark:9 13 13;--gray-50:243 247 246;--gray-100:238 242 241;--gray-200:222 226 226;--gray-300:206 210 209;--gray-400:158 163 162;--gray-500:112 116 115;--gray-600:80 84 83;--gray-700:62 67 66;--gray-800:37 41 40;--gray-900:23 27 26;--gray-950:10 14 13;--header:128 127 236;--hover-btn:52 51 116;--accent:103 101 232}header#header>div>div{color:rgb(var(--header))}body :is(.dark\\:bg-primary-light:is(.dark *)){background:rgb(var(--accent))}body :is(.dark\\:bg-primary-light\\/10:is(.dark *)){background:rgb(var(--hover-btn))}"}],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Welcome to Userpilot Documentation","description":"Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.","keywords":["Userpilot","Welcome","Documentation","users"],"mode":"wide","href":"/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,hr:`hr`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,Heading}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Trusted by thousands of product and customer teams, Userpilot is a product growth platform that empowers non-technical teams to create and optimize user onboarding, drive feature adoption, and boost customer retention across web and mobile, without writing a single line of code.`}),`\n`,_jsxs(`video`,{controls:true,autoplay:true,muted:true,loop:true,children:[_jsx(`source`,{src:`https://media.userpilot.io/docs/what-is-userpilot.mp4`,type:`video/mp4`}),_jsx(_components.p,{children:`Your browser does not support the video tag.`})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`what-can-you-do-with-userpilot`,children:`What can you do with Userpilot?`}),`\n`,_jsxs(`div`,{className:`mint-grid mint-grid-cols-1 md:mint-grid-cols-1 lg:mint-grid-cols-2 mint-gap-8 lg:mint-gap-4 mint-mt-8`,children:[_jsxs(`div`,{className:`mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-xl mint-p-8 mint-transition-all mint-duration-300`,children:[_jsxs(`div`,{className:`mint-flex mint-items-center mint-mb-6`,children:[_jsx(`div`,{className:`bg-primary mint-rounded-lg mint-p-3 mint-mr-4`,children:_jsx(`svg`,{className:`mint-w-6 mint-h-6 mint-text-white`,fill:`none`,stroke:`currentColor`,viewBox:`0 0 24 24`,children:_jsx(`path`,{strokeLinecap:`round`,strokeLinejoin:`round`,strokeWidth:2,d:`M13 10V3L4 14h7v7l9-11h-7z`})})}),_jsx(Heading,{level:`3`,id:`onboard-new-users-effectively`,className:`mint-text-xl mint-font-bold mint-text-gray-900 dark:mint-text-white mint-m-0`,children:_jsx(`p`,{className:`mint-m-0`,children:`Onboard new users effectively`})})]}),_jsx(`p`,{className:`mint-text-gray-700 dark:mint-text-gray-300 mint-leading-relaxed mint-mb-6`,children:_jsx(_components.p,{children:`Deliver contextual, in-app experiences that guide users to their βaha!β\nmoments faster with flows, tooltips, banners, and checklists. Reduce\ntime-to-value and increase activation rates.`})}),_jsxs(`ul`,{className:`mint-space-y-3 mint-list-none not-prose`,children:[_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Trigger flows based on user behavior`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Target by plan, lifecycle stage, or segments`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Use modals, tooltips, and checklists`})]})]})]}),_jsxs(`div`,{className:`mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-xl mint-p-8 mint-transition-all mint-duration-300`,children:[_jsxs(`div`,{className:`mint-flex mint-items-center mint-mb-6`,children:[_jsx(`div`,{className:`bg-primary mint-rounded-lg mint-p-3 mint-mr-4`,children:_jsx(`svg`,{className:`mint-w-6 mint-h-6 mint-text-white`,fill:`none`,stroke:`currentColor`,viewBox:`0 0 24 24`,children:_jsx(`path`,{strokeLinecap:`round`,strokeLinejoin:`round`,strokeWidth:2,d:`M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z`})})}),_jsx(Heading,{level:`3`,id:`drive-feature-discovery-and-adoption`,className:`mint-text-xl mint-font-bold mint-text-gray-900 dark:mint-text-white mint-m-0`,children:_jsx(`p`,{className:`mint-m-0`,children:`Drive feature discovery and adoption`})})]}),_jsx(`p`,{className:`mint-text-gray-700 dark:mint-text-gray-300 mint-leading-relaxed mint-mb-6`,children:_jsx(_components.p,{children:`Encourage users to explore new or underutilized features with targeted\nin-app messages and interactive walkthroughs. Increase feature adoption and\nuser engagement.`})}),_jsxs(`ul`,{className:`mint-space-y-3 mint-list-none not-prose`,children:[_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Highlight features based on usage patterns`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Promote beta launches with targeted messages`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Educate users with interactive walkthroughs`})]})]})]}),_jsxs(`div`,{className:`mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-xl mint-p-8 mint-transition-all mint-duration-300`,children:[_jsxs(`div`,{className:`mint-flex mint-items-center mint-mb-6`,children:[_jsx(`div`,{className:`bg-primary mint-rounded-lg mint-p-3 mint-mr-4`,children:_jsx(`svg`,{className:`mint-w-6 mint-h-6 mint-text-white`,fill:`none`,stroke:`currentColor`,viewBox:`0 0 24 24`,children:_jsx(`path`,{strokeLinecap:`round`,strokeLinejoin:`round`,strokeWidth:2,d:`M4.318 6.318a4.5 4.5 0 000 6.364L12 20.364l7.682-7.682a4.5 4.5 0 00-6.364-6.364L12 7.636l-1.318-1.318a4.5 4.5 0 00-6.364 0z`})})}),_jsx(Heading,{level:`3`,id:`improve-user-retention`,className:`mint-text-xl mint-font-bold mint-text-gray-900 dark:mint-text-white mint-m-0`,children:_jsx(`p`,{className:`mint-m-0`,children:`Improve user retention`})})]}),_jsx(`p`,{className:`mint-text-gray-700 dark:mint-text-gray-300 mint-leading-relaxed mint-mb-6`,children:_jsx(_components.p,{children:`Keep users engaged and help them build habits with segmentation, surveys,\nemails, and data-backed insights. Reduce churn and increase customer lifetime value.`})}),_jsxs(`ul`,{className:`mint-space-y-3 mint-list-none not-prose`,children:[_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Segment users based on activity or milestones`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Send in-app surveys and emails to capture feedback`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Identify drop-off points and iterate`})]})]})]}),_jsxs(`div`,{className:`mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-xl mint-p-8 mint-transition-all mint-duration-300`,children:[_jsxs(`div`,{className:`mint-flex mint-items-center mint-mb-6`,children:[_jsx(`div`,{className:`bg-primary mint-rounded-lg mint-p-3 mint-mr-4`,children:_jsx(`svg`,{className:`mint-w-6 mint-h-6 mint-text-white`,fill:`none`,stroke:`currentColor`,viewBox:`0 0 24 24`,children:_jsx(`path`,{strokeLinecap:`round`,strokeLinejoin:`round`,strokeWidth:2,d:`M9 19v-6a2 2 0 00-2-2H5a2 2 0 00-2 2v6a2 2 0 002 2h2a2 2 0 002-2zm0 0V9a2 2 0 012-2h2a2 2 0 012 2v10m-6 0a2 2 0 002 2h2a2 2 0 002-2m0 0V5a2 2 0 012-2h2a2 2 0 012 2v14a2 2 0 01-2 2h-2a2 2 0 01-2-2z`})})}),_jsx(Heading,{level:`3`,id:`measure-product-experience-impact`,className:`mint-text-xl mint-font-bold mint-text-gray-900 dark:mint-text-white mint-m-0`,children:_jsx(`p`,{className:`mint-m-0`,children:`Measure product experience impact`})})]}),_jsx(`p`,{className:`mint-text-gray-700 dark:mint-text-gray-300 mint-leading-relaxed mint-mb-6`,children:_jsx(_components.p,{children:`Track custom events, analyze flow performance, and correlate actions with\nengagement metrics. Make data-driven decisions to optimize your product\nexperience across web and mobile.`})}),_jsxs(`ul`,{className:`mint-space-y-3 mint-list-none not-prose`,children:[_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Track custom events and properties`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Analyze flow performance and feature usage`})]}),_jsxs(`li`,{className:`mint-flex mint-items-center mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[_jsx(`svg`,{className:`mint-w-4 mint-h-4 mint-text-gray-500 dark:mint-text-gray-400 mint-mr-3 mint-flex-shrink-0`,fill:`currentColor`,viewBox:`0 0 20 20`,children:_jsx(`path`,{fillRule:`evenodd`,d:`M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z`,clipRule:`evenodd`})}),_jsx(_components.p,{children:`Correlate actions with engagement metrics`})]})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`quick-start-guide`,children:`Quick Start Guide`}),`\n`,_jsxs(Heading,{level:`3`,id:`1-install-userpilot`,children:[`1. `,_jsx(_components.a,{href:`/developer/installation/web`,children:`Install Userpilot`})]}),`\n`,_jsx(_components.p,{children:`Get Userpilot running on your web or mobile application in minutes.`}),`\n`,_jsxs(Heading,{level:`3`,id:`2-create-your-first-flow`,children:[`2. `,_jsx(_components.a,{href:`/in-app-engagement/flows/getting-started/create-flow`,children:`Create your first flow`})]}),`\n`,_jsx(_components.p,{children:`Build in-app experiences using the Chrome Extension - no code needed.`}),`\n`,_jsxs(Heading,{level:`3`,id:`3-track-events-and-users`,children:[`3. `,_jsx(_components.a,{href:`/data-events/events-dashboard`,children:`Track events and users`})]}),`\n`,_jsx(_components.p,{children:`Set up event tracking to personalize experiences and measure impact.`}),`\n`,_jsxs(Heading,{level:`3`,id:`4-analyze-performance`,children:[`4. `,_jsx(_components.a,{href:`/product-analytics/reports/trends`,children:`Analyze performance`})]}),`\n`,_jsx(_components.p,{children:`Use dashboards and session replay to understand user behavior.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`popular-features`,children:`Popular Features`}),`\n`,_jsxs(`div`,{className:`mint-grid mint-grid-cols-1 md:mint-grid-cols-2 lg:mint-grid-cols-2 mint-gap-6 lg:mint-gap-4 mint-mt-8`,children:[_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%8E%AF-in-app-flows`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π― In-App Flows`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Create modals, tooltips, and interactive walkthroughs to guide users through\nyour product.`})}),_jsx(_components.a,{href:`/in-app-engagement/flows/getting-started/create-flow`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%93%8A-product-analytics`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π Product Analytics`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Track user behavior, analyze feature usage, and measure the impact of your\nexperiences.`})}),_jsx(_components.a,{href:`/product-analytics/reports/trends`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%93%9D-surveys-%26-nps`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π Surveys \u0026 NPS`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Collect user feedback with in-app surveys and Net Promoter Score (NPS)\nsurveys.`})}),_jsx(_components.a,{href:`/user-feedback/nps/create-nps`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%93%B1-mobile-content`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π± Mobile Content`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Deliver carousels, slideouts, and push notifications natively on iOS and Android apps.`})}),_jsx(_components.a,{href:`/in-app-engagement/mobile-content/get-started-with-mobile-content`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%93%A7-emails`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π§ Emails`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Re-engage users with behavior-based email campaigns and automated messaging.`})}),_jsx(_components.a,{href:`/in-app-engagement/emails/get-started-with-emails`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%94%8D-session-replay`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π Session Replay`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Watch how users interact with your product to identify pain points and\nopportunities.`})}),_jsx(_components.a,{href:`/sessions/session-replay`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%93%9A-resource-center`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π Resource Center`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Create a centralized hub for help articles, videos, and support resources.`})}),_jsx(_components.a,{href:`/in-app-engagement/resource-center/overview`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]}),_jsxs(`div`,{className:`mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-rounded-lg mint-p-6 mint-bg-white dark:mint-bg-gray-800 mint-transition-all mint-duration-300`,children:[_jsx(Heading,{level:`3`,id:`%F0%9F%94%97-integrations`,className:`mint-text-lg mint-font-semibold mint-mb-3 mint-mt-3 mint-text-gray-900 dark:mint-text-white`,children:`π Integrations`}),_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-mb-4`,children:_jsx(_components.p,{children:`Connect with your favorite tools like HubSpot, Salesforce, Segment, and\nmore.`})}),_jsx(_components.a,{href:`/integrations/overview`,className:`text-primary hover:text-primary-dark dark:text-primary-light`,children:_jsx(_components.p,{children:`Learn more β`})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`documentation-sections`,children:`Documentation Sections`}),`\n`,_jsx(Heading,{level:`3`,id:`platform`,children:_jsx(_components.strong,{children:`Platform`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/getting-started/what-is-userpilot`,children:`Getting Started`})}),` - Learn about Userpilot and set up your first experience`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/users-companies/dashboard`,children:`Users \u0026 Companies`})}),` - Manage user data, segments, and company information`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/data-events/events-dashboard`,children:`Data \u0026 Events`})}),` - Track user behavior and custom events`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/in-app-engagement/flows/getting-started/create-flow`,children:`In-App Engagement`})}),` - Create flows, spotlights, banners, checklists, mobile content, and emails`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/product-analytics/reports/trends`,children:`Product Analytics`})}),` - Analyze user behavior and feature usage`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/user-feedback/nps/create-nps`,children:`User Feedback`})}),` - Collect feedback with surveys and NPS`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/sessions/session-replay`,children:`Session Replay`})}),` - Watch user sessions to understand behavior`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`developer`,children:_jsx(_components.strong,{children:`Developer`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/developer/installation/web`,children:`Installation`})}),` - Set up Userpilot on web and mobile applications`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/developer/security/csp`,children:`Security`})}),` - Configure security settings and best practices`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/api-references/overview`,children:`APIs`})}),` - Integrate with Userpilotβs REST APIs`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/data-sync/overview`,children:`Data Sync`})}),` - Sync data with external systems`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`integrations`,children:_jsx(_components.strong,{children:`Integrations`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/integrations/overview`,children:`Native Integrations`})}),` - Connect with HubSpot, Salesforce, Segment, and more`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/integrations/webhooks`,children:`Webhooks`})}),` - Send data to external systems in real-time`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`need-help`,children:`Need Help?`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`How do I get started with Userpilot?`,defaultOpen:false,id:`how-do-i-get-started-with-userpilot`,children:_jsxs(_components.p,{children:[`Start by installing Userpilot on your application, then create your first flow using the Chrome Extension. Check out our `,_jsx(_components.a,{href:`/getting-started/quickstart`,children:`quickstart guide`}),` for step-by-step instructions.`]})}),` `,_jsx(Accordion,{title:`What's the difference between flows, spotlights, and banners?`,defaultOpen:false,id:`whats-the-difference-between-flows-spotlights-and-banners`,children:_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Flows`}),`: Multi-step interactive experiences (modals, tooltips, slideouts)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Spotlights`}),`: Highlight specific elements on your page`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Banners`}),`: Display messages at the top or bottom of the page`]}),`\n`]})}),` `,_jsx(Accordion,{title:`Can I use Userpilot on mobile apps?`,defaultOpen:false,id:`can-i-use-userpilot-on-mobile-apps`,children:_jsxs(_components.p,{children:[`Yes! Userpilot supports both iOS and Android applications. Check out our `,_jsx(_components.a,{href:`/developer/installation/mobile/overview`,children:`mobile installation guide`}),` for setup instructions.`]})}),_jsx(Accordion,{title:`How does Userpilot pricing work?`,defaultOpen:false,id:`how-does-userpilot-pricing-work`,children:_jsxs(_components.p,{children:[`Userpilot pricing is based on monthly active users (MAU). You can install Userpilot on as many applications and domains as you want. `,_jsx(_components.a,{href:`https://userpilot.com/userpilot-demo/`,children:`Contact our sales team`}),` for detailed pricing information.`]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Welcome to Userpilot Documentation","description":"Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.","keywords":["Userpilot","Welcome","Documentation","users"],"mode":"wide","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What can you do with Userpilot?","slug":"what-can-you-do-with-userpilot","depth":2,"children":[{"title":"Onboard new users effectively","slug":"onboard-new-users-effectively","depth":3,"children":[]},{"title":"Drive feature discovery and adoption","slug":"drive-feature-discovery-and-adoption","depth":3,"children":[]},{"title":"Improve user retention","slug":"improve-user-retention","depth":3,"children":[]},{"title":"Measure product experience impact","slug":"measure-product-experience-impact","depth":3,"children":[]}]},{"title":"Quick Start Guide","slug":"quick-start-guide","depth":2,"children":[{"title":"1. Install Userpilot","slug":"1-install-userpilot","depth":3,"children":[]},{"title":"2. Create your first flow","slug":"2-create-your-first-flow","depth":3,"children":[]},{"title":"3. Track events and users","slug":"3-track-events-and-users","depth":3,"children":[]},{"title":"4. Analyze performance","slug":"4-analyze-performance","depth":3,"children":[]}]},{"title":"Popular Features","slug":"popular-features","depth":2,"children":[{"title":"π― In-App Flows","slug":"%F0%9F%8E%AF-in-app-flows","depth":3,"children":[]},{"title":"π Product Analytics","slug":"%F0%9F%93%8A-product-analytics","depth":3,"children":[]},{"title":"π Surveys \u0026 NPS","slug":"%F0%9F%93%9D-surveys-%26-nps","depth":3,"children":[]},{"title":"π± Mobile Content","slug":"%F0%9F%93%B1-mobile-content","depth":3,"children":[]},{"title":"π§ Emails","slug":"%F0%9F%93%A7-emails","depth":3,"children":[]},{"title":"π Session Replay","slug":"%F0%9F%94%8D-session-replay","depth":3,"children":[]},{"title":"π Resource Center","slug":"%F0%9F%93%9A-resource-center","depth":3,"children":[]},{"title":"π Integrations","slug":"%F0%9F%94%97-integrations","depth":3,"children":[]}]},{"title":"Documentation Sections","slug":"documentation-sections","depth":2,"children":[{"title":"Platform","slug":"platform","depth":3,"children":[]},{"title":"Developer","slug":"developer","depth":3,"children":[]},{"title":"Integrations","slug":"integrations","depth":3,"children":[]}]},{"title":"Need Help?","slug":"need-help","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/userpilot/3ace2e9458eac66f/.prettierrc.js","/_mintlify/custom/userpilot/27d7e6557bc674e7/plausible.js","/_mintlify/custom/userpilot/222114e09e9d43ba/scripts/generate-kb-manifest.js","/_mintlify/custom/userpilot/7588c52f105b4ce6/scripts/check-nav.js","/_mintlify/custom/userpilot/77c4aabf1776912c/scripts/check-redirects.js","/_mintlify/custom/userpilot/c4efe6226e95d900/scripts/lib/docs-lib.js","/_mintlify/custom/userpilot/8278790c2c1428e5/scripts/precommit.js","/_mintlify/custom/userpilot/826df8c2727af7c1/scripts/seo-audit.js"],"dynamicCss":".mint-m-0 {\n margin: 0px\n}\n.mint-mb-3 {\n margin-bottom: 0.75rem\n}\n.mint-mb-4 {\n margin-bottom: 1rem\n}\n.mint-mb-6 {\n margin-bottom: 1.5rem\n}\n.mint-mr-3 {\n margin-right: 0.75rem\n}\n.mint-mr-4 {\n margin-right: 1rem\n}\n.mint-mt-3 {\n margin-top: 0.75rem\n}\n.mint-mt-8 {\n margin-top: 2rem\n}\n.mint-flex {\n display: flex\n}\n.mint-grid {\n display: grid\n}\n.mint-h-4 {\n height: 1rem\n}\n.mint-h-6 {\n height: 1.5rem\n}\n.mint-w-4 {\n width: 1rem\n}\n.mint-w-6 {\n width: 1.5rem\n}\n.mint-flex-shrink-0 {\n flex-shrink: 0\n}\n.mint-list-none {\n list-style-type: none\n}\n.mint-grid-cols-1 {\n grid-template-columns: repeat(1, minmax(0, 1fr))\n}\n.mint-items-center {\n align-items: center\n}\n.mint-gap-6 {\n gap: 1.5rem\n}\n.mint-gap-8 {\n gap: 2rem\n}\n.mint-space-y-3 > :not([hidden]) ~ :not([hidden]) {\n --tw-space-y-reverse: 0;\n margin-top: calc(0.75rem * calc(1 - var(--tw-space-y-reverse)));\n margin-bottom: calc(0.75rem * var(--tw-space-y-reverse))\n}\n.mint-rounded-lg {\n border-radius: 0.5rem\n}\n.mint-rounded-xl {\n border-radius: 0.75rem\n}\n.mint-border {\n border-width: 1px\n}\n.mint-border-gray-200 {\n --tw-border-opacity: 1;\n border-color: rgb(229 231 235 / var(--tw-border-opacity, 1))\n}\n.mint-bg-white {\n --tw-bg-opacity: 1;\n background-color: rgb(255 255 255 / var(--tw-bg-opacity, 1))\n}\n.mint-p-3 {\n padding: 0.75rem\n}\n.mint-p-6 {\n padding: 1.5rem\n}\n.mint-p-8 {\n padding: 2rem\n}\n.mint-text-lg {\n font-size: 1.125rem;\n line-height: 1.75rem\n}\n.mint-text-sm {\n font-size: 0.875rem;\n line-height: 1.25rem\n}\n.mint-text-xl {\n font-size: 1.25rem;\n line-height: 1.75rem\n}\n.mint-font-bold {\n font-weight: 700\n}\n.mint-font-semibold {\n font-weight: 600\n}\n.mint-leading-relaxed {\n line-height: 1.625\n}\n.mint-text-gray-500 {\n --tw-text-opacity: 1;\n color: rgb(107 114 128 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-600 {\n --tw-text-opacity: 1;\n color: rgb(75 85 99 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-700 {\n --tw-text-opacity: 1;\n color: rgb(55 65 81 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-900 {\n --tw-text-opacity: 1;\n color: rgb(17 24 39 / var(--tw-text-opacity, 1))\n}\n.mint-text-white {\n --tw-text-opacity: 1;\n color: rgb(255 255 255 / var(--tw-text-opacity, 1))\n}\n.mint-transition-all {\n transition-property: all;\n transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);\n transition-duration: 150ms\n}\n.mint-duration-300 {\n transition-duration: 300ms\n}\n.dark\\:mint-border-gray-700:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(55 65 81 / var(--tw-border-opacity, 1))\n}\n.dark\\:mint-bg-gray-800:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(31 41 55 / var(--tw-bg-opacity, 1))\n}\n.dark\\:mint-text-gray-300:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(209 213 219 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(156 163 175 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-white:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 255 255 / var(--tw-text-opacity, 1))\n}\n@media (min-width: 768px) {\n .md\\:mint-grid-cols-1 {\n grid-template-columns: repeat(1, minmax(0, 1fr))\n }\n .md\\:mint-grid-cols-2 {\n grid-template-columns: repeat(2, minmax(0, 1fr))\n }\n}\n@media (min-width: 1024px) {\n .lg\\:mint-grid-cols-2 {\n grid-template-columns: repeat(2, minmax(0, 1fr))\n }\n .lg\\:mint-gap-4 {\n gap: 1rem\n }\n}","subdomain":"userpilot","siteName":"Userpilot Knowledge Base","title":"Welcome to Userpilot Documentation - Userpilot Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T20:58:42.662Z","originalFileLocation":"index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome to Userpilot Documentation - Userpilot Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userpilot.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.userpilot.com/up-logo-dark.svg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Welcome to Userpilot Documentation - Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Complete guide to Userpilot - the product growth platform that helps you onboard users, drive feature adoption, and boost retention without code.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.userpilot.com/up-logo-dark.svg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6765e8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userpilot.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Userpilot Knowledge Base\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Userpilot Knowledge Base","nav":{"global":null,"tabs":[{"tab":"Platform","groups":[{"group":"Userpilot Overview","pages":[{"title":"What is Userpilot?","href":"/getting-started/what-is-userpilot"},{"title":"What does Userpilot offer?","href":"/getting-started/what-does-userpilot-offer"}]},{"group":"Welcome to Userpilot","pages":[{"title":"Get started with Userpilot","href":"/welcome-to-userpilot/get-started-with-userpilot"},{"title":"Userpilot Installation Quickstart","sidebarTitle":"Installation Quickstart","href":"/getting-started/quickstart"}]},{"group":"Users and Companies","pages":[{"title":"Users \u0026 Companies Dashboard","sidebarTitle":"Dashboard","icon":"users","href":"/users-companies/dashboard"},{"title":"Segments","icon":"chart-pie-simple","href":"/users-companies/segments"},{"title":"Profiles","icon":"address-card","href":"/users-companies/profile"}]},{"group":"Data and Events","pages":[{"group":"Events","icon":"code","pages":[{"title":"Events Dashboard","href":"/data-events/events-dashboard"},{"title":"Select The Right Element","sidebarTitle":"Element Detection","href":"/data-events/select-eleme-events"}]},{"group":"Event Types","icon":"tag","pages":[{"title":"Labeled Events (Visually/CSS)","href":"/data-events/autocapture/visual-labeler"},{"title":"Tracked Events","href":"/data-events/tracked-events/tracked-events"},{"title":"Custom Events","icon":"cube","href":"/data-events/tracked-events/custom-events"}]},{"group":"Auto-capture","icon":"bullseye-pointer","pages":[{"title":"Raw Events","href":"/data-events/autocapture/raw-events"},{"title":"Labeled Events (Visually/CSS)","href":"/data-events/autocapture/visual-labeler"},{"title":"Mobile Event Auto-Capture","href":"/data-events/autocapture/mobile-events-autocapture"}]},{"group":"Page Tracking","icon":"window","pages":[{"title":"Page Tracking","href":"/data-events/page-tracking/pages-dashboard"}]},{"group":"Mobile Screen Tracking","icon":"mobile-screen-button","pages":[{"title":"Track Mobile Screens Manually","href":"/data-events/mobile-screen-tracking/track-mobile-screens-manually"},{"title":"Mobile Screen Auto Capture","href":"/data-events/mobile-screen-tracking/mobile-screen-auto-capture"}]}]},{"group":"Chrome Extension Basics","pages":[{"title":"Button Actions","icon":"rectangle-history","href":"/ce-basics/button-actions"},{"title":"Embeds","icon":"square-plus","href":"/ce-basics/embeds"},{"title":"UI Templates","icon":"bookmark","href":"/ce-basics/ui-templates"},{"title":"AI Assistant","icon":"microchip-ai","href":"/ce-basics/ai-assistant"},{"title":"Personalize Content","icon":"user","href":"/ce-basics/personalize-content"},{"title":"Switching Themes","icon":"palette","href":"/ce-basics/switching-themes"},{"title":"Select The Right Element","sidebarTitle":"Element Detection","icon":"highlighter-line","href":"/ce-basics/select-element"},{"title":"Create \u0026 Preview Content","icon":"eye","href":"/ce-basics/preview-content"}]},{"group":"In App Engagement","pages":[{"group":"Flows","icon":"arrow-progress","pages":[{"group":"Getting Started","pages":[{"title":"Setup a Theme","href":"/in-app-engagement/flows/getting-started/themes"},{"title":"Create a Flow","href":"/in-app-engagement/flows/getting-started/create-flow"},{"title":"Set up Flow Settings","sidebarTitle":"Flow Settings","href":"/in-app-engagement/flows/getting-started/flow-settings"},{"title":"Best Practices","href":"/in-app-engagement/flows/getting-started/best-practices"},{"title":"Testing Flows","href":"/in-app-engagement/flows/getting-started/testing-flows"},{"title":"Flow performance analytics","href":"/in-app-engagement/flows/getting-started/Flow-performance-analytics"}]},{"group":"Chrome Extension","pages":[{"title":"Flow Logic","href":"/in-app-engagement/flows/CE/logic"},{"title":"Progressive Groups","sidebarTitle":"Groups","href":"/in-app-engagement/flows/CE/groups"},{"title":"Page Changes","href":"/in-app-engagement/flows/CE/page-changes"},{"title":"Localize Flows","href":"/in-app-engagement/flows/CE/localize"}]},{"group":"Use Cases","pages":[{"title":"Experiments","href":"/in-app-engagement/flows/use-cases/AB-testing"},{"title":"Ordering \u0026 Throttling","href":"/in-app-engagement/flows/use-cases/order-throttle"},{"title":"Form Responses","icon":"file-circle-question","href":"/in-app-engagement/flows/use-cases/forms"}]}]},{"group":"Spotlights","icon":"lightbulb-message","pages":[{"title":"Overview","href":"/in-app-engagement/spotlights/overview"},{"title":"Native Tooltips","href":"/in-app-engagement/spotlights/native-tooltips"},{"title":"Buttons","href":"/in-app-engagement/spotlights/buttons"},{"title":"Hotspots","href":"/in-app-engagement/spotlights/hotspots"},{"title":"Spotlight Settings ","href":"/in-app-engagement/spotlights/targeting-settings"}]},{"group":"Embeds","icon":"flag-pennant","pages":[{"title":"Create Banner","href":"/in-app-engagement/embeds/create-banner"},{"title":"Create Card","href":"/in-app-engagement/embeds/create-card"},{"title":"Targeting an Embed","href":"/in-app-engagement/embeds/targeting"}]},{"group":"Resource Center","icon":"book","pages":[{"title":"Resource Center Overview","sidebarTitle":"Overview","href":"/in-app-engagement/resource-center/overview"},{"group":"Create and Manage","pages":[{"title":"Resource Center Setup","sidebarTitle":"Content","href":"/in-app-engagement/resource-center/create"},{"title":"Resource Center Targeting Settings","sidebarTitle":"Targeting","href":"/in-app-engagement/resource-center/targeting"},{"title":"Resource Center Style and Triggering","sidebarTitle":"Style and Triggering","href":"/in-app-engagement/resource-center/style"},{"title":"Localize Resource Center Content","sidebarTitle":"Localization","href":"/in-app-engagement/resource-center/localization"},{"title":"Testing and Publishing Resource Center","sidebarTitle":"Testing and Publishing","href":"/in-app-engagement/resource-center/testing-publishing"},{"title":"Adding a Video to the Resource Center","sidebarTitle":"Video Content","href":"/in-app-engagement/resource-center/video-content"}]},{"group":"Knowledge Base","pages":[{"title":"Knowledge Base Integrations","sidebarTitle":"Knowledge Base Integrations","href":"/in-app-engagement/resource-center/knowledge-base-integrations"},{"title":"Zendesk Integration","href":"/in-app-engagement/resource-center/zendesk-integration"}]}]},{"group":"Checklists","icon":"list-check","pages":[{"title":"Getting Started with Checklists","sidebarTitle":"Overview","href":"/in-app-engagement/checklists/overview"},{"group":"Create and Manage","pages":[{"title":"Create a Checklist","href":"/in-app-engagement/checklists/create-checklist"},{"title":"Style Checklist Widget","sidebarTitle":"Style Widget","href":"/in-app-engagement/checklists/style"},{"title":"Localization","href":"/in-app-engagement/checklists/localization"},{"title":"Targeting a Checklist","href":"/in-app-engagement/checklists/targeting-checklist"},{"title":"Trigger and Beacon Settings","sidebarTitle":"Trigger and Beacon Settings","href":"/in-app-engagement/checklists/trigger-and-beacon-settings"},{"title":"Testing and Publishing Checklists","sidebarTitle":"Test and Publish","href":"/in-app-engagement/checklists/test-and-publish"}]},{"title":"Checklist Overview and Analytics","sidebarTitle":"Analytics","href":"/in-app-engagement/checklists/ChecklistOverviewandAnalytics"}]},{"group":"Mobile Content","icon":"mobile-notch","pages":[{"title":"Get started with mobile content","href":"/in-app-engagement/mobile-content/get-started-with-mobile-content"},{"title":"Build a Mobile Carousel","href":"/in-app-engagement/mobile-content/build-mobile-carousel"},{"title":"Build a Mobile Slideout","href":"/in-app-engagement/mobile-content/build-a-mobile-slideout"},{"title":"Mobile Push Notifications","href":"/in-app-engagement/mobile-content/mobile-push-notifications"},{"title":"Mobile content ordering \u0026 throttling","href":"/in-app-engagement/mobile-content/mobile-content-ordering"},{"title":"Mobile content overview","href":"/in-app-engagement/mobile-content/mobile-content-overview"},{"title":"Mobile content performance analytics","href":"/in-app-engagement/mobile-content/mobile-content-performance-analytics"},{"title":"Preparing to Send Push Notifications","href":"/in-app-engagement/mobile-content/preparing-to-send-push-notifications"}]},{"group":"Emails","icon":"envelope","pages":[{"title":"Userpilot's Email Sending Guidelines","href":"/in-app-engagement/emails/userpilots-email-sending-guidelines"},{"title":"Get started with emails","href":"/in-app-engagement/emails/get-started-with-emails"},{"title":"Setup and authenticate your email domain","href":"/in-app-engagement/emails/setup-and-authenticate-email-domain"},{"title":"Email performance analytics","href":"/in-app-engagement/emails/email-performance-analytics"},{"title":"Email deliverability performance metrics","href":"/in-app-engagement/emails/view-and-analyze-domain-level-performance"},{"title":"Add email addresses","href":"/in-app-engagement/emails/add-email-addresses"},{"title":"Customize email signature","href":"/in-app-engagement/emails/customize-email-signature"},{"title":"Manage email subscriptions","href":"/in-app-engagement/emails/manage-email-subscriptions"},{"title":"Manage unsubscribes","href":"/in-app-engagement/emails/manage-unsubscribes"},{"title":"Suppression list","href":"/in-app-engagement/emails/suppression-list"},{"title":"Design email theme","href":"/in-app-engagement/emails/design-email-theme"}]}]},{"group":"Workflows","pages":[{"title":"Building your Workflow","icon":"diagram-next","href":"/building-your-workflow"},{"title":"Workflow performance analytics","icon":"chart-line","href":"/workflow-performance-analytics"}]},{"group":"Product Analytics","pages":[{"group":"Reports","icon":"chart-mixed","pages":[{"title":"Trends","href":"/product-analytics/reports/trends"},{"title":"Funnels","href":"/product-analytics/reports/funnels"},{"title":"Paths","href":"/product-analytics/reports/paths"},{"title":"Retention","href":"/product-analytics/reports/retention"}]},{"group":"Dashboards","icon":"objects-column","pages":[{"title":"Product Usage Dashboard","href":"/product-analytics/dashboards/product-usage"},{"title":"Feature Engagement","href":"/product-analytics/dashboards/feature-engagement"},{"title":"User Activation Dashboard","href":"/product-analytics/dashboards/user-activation"},{"title":"User Retention Dashboard","href":"/product-analytics/dashboards/user-retention"},{"title":"Free to Paid Conversion","href":"/product-analytics/dashboards/free-to-paid-conversion"},{"title":"Expansion Revenue","href":"/product-analytics/dashboards/expansion-revenue"},{"title":"Custom Dashboards","href":"/product-analytics/dashboards/custom-dashboards"}]}]},{"group":"User Feedback","pages":[{"group":"NPS","icon":"face-smile","pages":[{"title":"Create an NPS","href":"/user-feedback/nps/create-nps"},{"title":"NPS Responses and Analytics","sidebarTitle":"NPS Responses","href":"/user-feedback/nps/nps-responses"},{"title":"NPS Settings","href":"/user-feedback/nps/nps-settings"}]},{"group":"Surveys","icon":"square-poll-horizontal","pages":[{"title":"Get started with survey","href":"/user-feedback/surveys/create-survey"},{"title":"Survey details and analytics","sidebarTitle":"Survey Responses","href":"/user-feedback/surveys/survey-details-and-analytics"},{"title":"User responses","href":"/user-feedback/surveys/user-responses"}]},{"title":"Form Responses","icon":"file-circle-question","href":"/in-app-engagement/flows/use-cases/forms"}]},{"group":"Session Replay","pages":[{"title":"Session Replay","icon":"play","href":"/sessions/session-replay"}]},{"group":"AI","pages":[{"title":"Welcome to Lia","icon":"sparkles","href":"/ai/welcome-to-lia"},{"title":"Userpilot MCP Server","icon":"sparkles","href":"/ai/userpilot-mcp-server"},{"group":"Agent Analytics","icon":"sparkles","pages":[{"title":"Overview","href":"/agent-a-overview"},{"title":"Topics","href":"/topics"},{"title":"Failure Signals","href":"/failure-signals"},{"title":"Agent Conversation Transcripts","href":"/agent-conversation-transcripts"}]}]},{"group":"Admin Console","pages":[{"title":"Admin Console","icon":"briefcase","sidebarTitle":"Overview","href":"/admin-console/overview"},{"title":"Cloning Content Across Applications","href":"/admin-console/duplicating-and-cloning-content-across-applications"}]},{"group":"Configure","pages":[{"group":"Themes and Design Library","icon":"palette","pages":[{"title":"Get started","href":"/configure/themes-and-design-library/get-started"},{"title":"Set up a web app theme","href":"/configure/themes-and-design-library/set-up-a-web-app-theme"},{"title":"Set up a mobile app theme","href":"/configure/themes-and-design-library/set-up-a-mobile-app-theme"},{"title":"Set up a design library","href":"/configure/themes-and-design-library/set-up-a-design-library"},{"title":"Theme Switching","href":"/configure/themes-and-design-library/switching-themes"}]},{"group":"Notifications","icon":"bell","pages":[{"title":"Get started with notifications","href":"/configure/notifications/get-started-with-notifications"},{"title":"System notifications","href":"/configure/notifications/system-notifications"},{"title":"Signal notifications","href":"/configure/notifications/signals"},{"title":"Digest notification","href":"/configure/notifications/digest"}]},{"group":"Teams","icon":"users","pages":[{"title":"Managing your team in Userpilot","href":"/configure/team-and-roles/managing-your-team-in-userpilot"},{"title":"Access and activity logs","href":"/configure/team-and-roles/access-and-activity-logs"},{"title":"Two-Factor Authentication (2FA)","href":"/configure/team-and-roles/2fa"},{"title":"SSO","href":"/configure/team-and-roles/sso"},{"title":"Just-in-Time (JIT) Provisioning","href":"/configure/team-and-roles/jit"},{"title":"SCIM Integration","href":"/configure/team-and-roles/scim"},{"title":"Bulk Teammate Import (CSV)","href":"/configure/team-and-roles/csv-import"}]},{"group":"Navigation and Interface","icon":"location-arrow","pages":[{"title":"Inbox","href":"/navigation-and-interface/inbox"},{"title":"Global search","href":"/navigation-and-interface/global-search"}]},{"group":"Accessibility","icon":"universal-access","pages":[{"title":"Accessibility in Userpilot in-app messages","href":"/accessibility/accessibility-in-userpilot-in-app-messages"}]},{"group":"Exclude Lists","icon":"list","pages":[{"title":"Exclude CSS Selectors","href":"/configure/exclude-lists/dynamic-attributes"},{"title":"Exclude Users and Companies","href":"/configure/exclude-lists/exclude-user"}]},{"group":"Data \u0026 Privacy","icon":"shield-halved","pages":[{"title":"Data Retention","icon":"clock-rotate-left","href":"/configure/data-retention/data-retention"},{"title":"Data Capture \u0026 Privacy","icon":"database","href":"/configure/data-capture-and-privacy/data-capture-and-privacy"}]}]},{"group":"Reference","icon":"book","pages":[{"title":"When to Use What in Userpilot","href":"/reference/when-to-use"},{"title":"Userpilot Data Model","href":"/reference/data-model"},{"title":"Userpilot Glossary","href":"/reference/glossary"},{"title":"Userpilot Error Reference","href":"/reference/errors"}]}]},{"tab":"Integrations","groups":[{"group":"Integrations","pages":[{"title":"Overview","href":"/integrations/overview"}]},{"group":"Native Integrations","pages":[{"title":"HubSpot Integration","sidebarTitle":"HubSpot","href":"/integrations/hubspot"},{"group":"Salesforce","pages":[{"title":"Salesforce Integration","sidebarTitle":"Salesforce","href":"/integrations/salesforce"},{"title":"Adding Custom Objects in SalesForce","sidebarTitle":"Add Custom Objects","href":"/integrations/sf-custom-objects"}]},{"title":"Segment Integration","sidebarTitle":"Segment","href":"/integrations/segment"},{"title":"Intercom Integration","sidebarTitle":"Intercom","href":"/integrations/intercom"},{"title":"Amplitude Integration","sidebarTitle":"Amplitude","href":"/integrations/amplitude"},{"title":"Mixpanel Integration","sidebarTitle":"Mixpanel","href":"/integrations/mixpanel"},{"title":"Heap Integration","href":"/integrations/heap"},{"title":"Google Analytics Integration","href":"/integrations/google-analytics"},{"title":"Slack Integration","href":"/integrations/slack"},{"title":"Microsoft Teams Integration","href":"/integrations/microsoft-teams"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/integrations/webhooks"}]}]},{"tab":"Developer","groups":[{"group":"Installation","icon":"gear-code","pages":[{"group":"Web","pages":[{"title":"Web Installation","sidebarTitle":"Overview","href":"/developer/installation/web"},{"title":"Agent SDK Installation","sidebarTitle":"Agents SDK","href":"/agent-sdk-installation"},{"group":"SDK Settings","icon":"sliders","pages":[{"title":"Callbacks","href":"/developer/installation/sdk/settings/callbacks"},{"title":"Integrations Interfaces","sidebarTitle":"Integration Interfaces","href":"/developer/installation/sdk/settings/integrations_interfaces"},{"title":"Auto-Capture Privacy Settings","href":"/developer/installation/sdk/settings/privacy"}]}]},{"group":"Mobile","pages":[{"title":"Install Userpilot Mobile SDK","sidebarTitle":"Overview","href":"/developer/installation/mobile/overview"},{"title":"Mobile Autocapture Screen Migration","href":"/developer/installation/mobile/mobile-autocapture-screen-migration"},{"group":"iOS","pages":[{"title":"iOS SDK","sidebarTitle":"Installation","href":"/developer/installation/mobile/ios/installation"},{"title":"Callbacks","href":"/developer/installation/mobile/ios/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/ios/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/ios/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/ios/auto-capture"},{"title":"Multi-Instance","href":"/developer/installation/mobile/ios/multi-instance"},{"title":"Fonts","href":"/developer/installation/mobile/ios/fonts"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/ios/features"},{"title":"Userpilot iOS SDK Release Notes","href":"/developer/installation/mobile/ios/mobile-ios-release-notes"}]},{"group":"Android","pages":[{"title":"Android SDK","sidebarTitle":"Installation","href":"/developer/installation/mobile/android/installation"},{"title":"Callbacks","href":"/developer/installation/mobile/android/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/android/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/android/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/android/auto-capture"},{"title":"Multi-Instance","href":"/developer/installation/mobile/android/multi-instance"},{"title":"Fonts","href":"/developer/installation/mobile/android/fonts"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/android/features"},{"title":"Userpilot Android SDK Release Notes","href":"/developer/installation/mobile/android/mobile-android-release-notes"}]},{"group":"Flutter","pages":[{"title":"Flutter Plugin","sidebarTitle":"Installation","href":"/developer/installation/mobile/flutter/installation"},{"title":"Updating to Swift Package Manager","sidebarTitle":"Updating to SPM","href":"/developer/installation/mobile/flutter/updating-to-spm"},{"title":"Callbacks","href":"/developer/installation/mobile/flutter/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/flutter/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/flutter/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/flutter/auto-capture"},{"title":"Fonts","href":"/developer/installation/mobile/flutter/fonts"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/flutter/features"},{"title":"Userpilot Flutter SDK Release Notes","href":"/developer/installation/mobile/flutter/mobile-flutter-release-notes"}]},{"group":"React Native","pages":[{"title":"React Native Module","sidebarTitle":"Installation","href":"/developer/installation/mobile/react-native/installation"},{"title":"Callbacks","href":"/developer/installation/mobile/react-native/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/react-native/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/react-native/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/react-native/auto-capture"},{"title":"Auto Screen Tracking With React Navigation","href":"/developer/installation/mobile/react-native/auto-track-screens"},{"title":"Fonts","href":"/developer/installation/mobile/react-native/fonts"},{"title":"Userpilot React Native with Expo","href":"/developer/installation/mobile/react-native/expo"},{"title":"Custom URL Scheme with Expo","sidebarTitle":"Expo Custom URL Scheme","href":"/developer/installation/mobile/react-native/expo_custom_scheme"},{"title":"Expo","href":"/developer/installation/mobile/mobile-expo-push-notification"},{"title":"Custom Fonts with Expo","href":"/developer/installation/mobile/react-native/expo_custom_fonts"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/react-native/features"},{"title":"Userpilot React Native SDK Release Notes","href":"/developer/installation/mobile/react-native/mobile-react-native-release-notes"}]},{"group":"Capacitor","pages":[{"title":"Ionic Capacitor plugin","sidebarTitle":"Installation","href":"/developer/installation/mobile/capacitor/installation"},{"title":"Updating to Swift Package Manager","sidebarTitle":"Updating to SPM","href":"/developer/installation/mobile/capacitor/updating-to-spm"},{"title":"Callbacks","href":"/developer/installation/mobile/capacitor/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/capacitor/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/capacitor/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/capacitor/auto-capture"},{"title":"Fonts","href":"/developer/installation/mobile/capacitor/fonts"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/capacitor/features"},{"title":"Userpilot Capacitor SDK Release Notes","href":"/developer/installation/mobile/capacitor/mobile-capacitor-release-notes"}]},{"group":"Cordova","pages":[{"title":"Cordova plugin","sidebarTitle":"Installation","href":"/developer/installation/mobile/cordova/installation"},{"title":"Callbacks","href":"/developer/installation/mobile/cordova/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/cordova/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/cordova/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/cordova/auto-capture"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/cordova/features"},{"title":"Userpilot Cordova SDK Release Notes","href":"/developer/installation/mobile/cordova/mobile-cordova-release-notes"}]},{"group":"MAUI","pages":[{"title":"MAUI SDK","sidebarTitle":"Installation","href":"/developer/installation/mobile/maui/installation"},{"title":"Callbacks","href":"/developer/installation/mobile/maui/callbacks"},{"title":"Push Notifications","href":"/developer/installation/mobile/maui/push-notifications"},{"title":"Custom URL Scheme","href":"/developer/installation/mobile/maui/custom_scheme"},{"title":"Auto Capture","href":"/developer/installation/mobile/maui/auto-capture"},{"title":"Userpilot SDK features","sidebarTitle":"Features","href":"/developer/installation/mobile/maui/features"},{"title":"Userpilot MAUI SDK Release Notes","href":"/developer/installation/mobile/maui/mobile-maui-release-notes"}]},{"group":"Segment","pages":[{"title":"Analytics iOS Userpilot","href":"/developer/mobile-segment/mobile-segment-ios"},{"title":"Analytics Kotlin Userpilot","href":"/developer/mobile-segment/mobile-segment-android"},{"title":"Analytics ReactNative Userpilot","href":"/developer/mobile-segment/mobile-segment-react-native"}]}]},{"title":"Production and Staging Evironments","sidebarTitle":"Production and Staging","href":"/developer/installation/production-staging"},{"title":"Self-hosting the SDK","href":"/developer/installation/self-host"},{"title":"Anonymous Users","href":"/developer/installation/anonymous-user"}]},{"group":"Security","icon":"lock","pages":[{"title":"Content Security Policy (CSP)","sidebarTitle":"Content Security Policy ","href":"/developer/security/csp"},{"title":"Subresource Integrity (SRI)","href":"/developer/security/sri"}]},{"group":"Data sync","icon":"users","pages":[{"title":"Data sync overview","sidebarTitle":"Overview","href":"/data-sync/overview"},{"title":"Prerequisites","sidebarTitle":"Prerequisites","href":"/data-sync/prerequisites"},{"title":"Understanding Your Data","sidebarTitle":"Understanding Your Data","href":"/data-sync/understand-data"},{"title":"Event Schema","sidebarTitle":"Event Schema","href":"/data-sync/event-schema"},{"title":"Setup and configuration","sidebarTitle":"Setup and configuration","href":"/data-sync/setup-and-configuration"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","href":"/data-sync/troubleshooting"},{"title":"Frequently Asked Questions","sidebarTitle":"FAQ","href":"/data-sync/faq"}]},{"group":"Advanced","pages":[{"title":"JavaScript SDK","href":"/developer/installation/SDK-APIs"},{"title":"Identify vs Reload","href":"/developer/identify-vs-reload"},{"title":"Custom Domain Hosting","href":"/developer/custom-domain"}]}]},{"tab":"APIs","groups":[{"group":"APIs","icon":"rectangle-terminal","pages":[{"title":"Userpilot API Documentation","sidebarTitle":"Overview","mode":"wide","href":"/api-references/overview"},{"title":"Authentication","href":"/api-references/authentication"},{"title":"Environment","href":"/api-references/environment"}]},{"group":"Real-time HTTP","pages":[{"title":"Overview","href":"/api-references/real-time/overview"},{"title":"Identify User","href":"/api-references/real-time/identify-user"},{"title":"Identify Company","href":"/api-references/real-time/identify-company"},{"title":"Track Event","href":"/api-references/real-time/track-event"},{"group":"Endpoints","pages":[{"title":"Identify User","openapi":"POST /v1/identify","href":"/api-references/endpoints/realtime/identify-user"},{"title":"Identify Company","openapi":"POST /v1/companies/identify","href":"/api-references/endpoints/realtime/identify-company"},{"title":"Track Event","openapi":"POST /v1/track","href":"/api-references/endpoints/realtime/track-event"}]}]},{"group":"Bulk Identify/Update","pages":[{"title":"Bulk Identify/Update Users","sidebarTitle":"Users","href":"/api-references/bulk-updates/users"},{"title":"Bulk Identify/Update Companies","sidebarTitle":"Companies","href":"/api-references/bulk-updates/companies"},{"group":"Endpoints","pages":[{"title":"Bulk Users Update","sidebarTitle":"Users","openapi":"POST /v1/users/bulk_identify","href":"/api-references/endpoints/bulk/users"},{"title":"Bulk Companies Update","sidebarTitle":"Companies","openapi":"POST /v1/companies/bulk_identify","href":"/api-references/endpoints/bulk/companies"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"}]}]},{"group":"Bulk Import","pages":[{"title":"Events Bulk Import","sidebarTitle":"Overview","href":"/api-references/import/overview"},{"title":"Event Schema","href":"/api-references/import/event-schema"},{"title":"Row Validation Rules","href":"/api-references/import/row-validation"},{"title":"User \u0026 Company Accumulative Properties Best Practices","sidebarTitle":"Best Practices","href":"/api-references/import/best-practices"},{"group":"Endpoints","pages":[{"title":"Import Job","openapi":"POST /v1/imports","href":"/api-references/endpoints/import/import-job"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"}]}]},{"group":"Bulk Export","pages":[{"title":"Bulk Data Export API","sidebarTitle":"Overview","href":"/api-references/export/overview"},{"title":"Event Schema","sidebarTitle":"Event Schema","href":"/api-references/export/event-schema"},{"title":"Data Lookups","sidebarTitle":"Data Lookups","href":"/api-references/export/lookups"},{"group":"Endpoints","pages":[{"title":"Export Job","sidebarTitle":"Export Job","openapi":"POST /api/v1/analytics/exports","href":"/api-references/endpoints/export/export-job"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"},{"group":"Lookups","pages":[{"title":"User Properties","sidebarTitle":"User Properties","openapi":"GET /api/v1/analytics/exports/lookups/user_properties","href":"/api-references/endpoints/lookups/user-properties"},{"title":"Company Properties","sidebarTitle":"Company Properties","openapi":"GET /api/v1/analytics/exports/lookups/company_properties","href":"/api-references/endpoints/lookups/company-properties"},{"title":"Segments","sidebarTitle":"Segments","openapi":"GET /api/v1/analytics/exports/lookups/segments","href":"/api-references/endpoints/lookups/segments"},{"title":"Features \u0026 Events","sidebarTitle":"Features \u0026 Events","openapi":"GET /api/v1/analytics/exports/lookups/features_events","href":"/api-references/endpoints/lookups/features-events"},{"title":"Flows","sidebarTitle":"Flows","openapi":"GET /api/v1/analytics/exports/lookups/flows","href":"/api-references/endpoints/lookups/flows"},{"title":"Banners","sidebarTitle":"Banners","openapi":"GET /api/v1/analytics/exports/lookups/banners","href":"/api-references/endpoints/lookups/banners"},{"title":"Embeds","sidebarTitle":"Embeds","openapi":"GET /api/v1/analytics/exports/lookups/embeds","href":"/api-references/endpoints/lookups/embeds"},{"title":"Spotlights","sidebarTitle":"Spotlights","openapi":"GET /api/v1/analytics/exports/lookups/spotlights","href":"/api-references/endpoints/lookups/spotlights"},{"title":"Checklists","sidebarTitle":"Checklists","openapi":"GET /api/v1/analytics/exports/lookups/checklists","href":"/api-references/endpoints/lookups/checklists"},{"title":"Surveys","sidebarTitle":"Surveys","openapi":"GET /api/v1/analytics/exports/lookups/surveys","href":"/api-references/endpoints/lookups/surveys"},{"title":"Resource Center Modules","sidebarTitle":"Resource Center Modules","openapi":"GET /api/v1/analytics/exports/lookups/resource_center_modules","href":"/api-references/endpoints/lookups/resource-center-modules"}]}]}]},{"group":"Email Subscriptions","pages":[{"title":"List Subscription Topics","href":"/api-references/email-subscriptions/list-topics"},{"title":"Set Subscription Preferences","href":"/api-references/email-subscriptions/set-preferences"}]},{"group":"Bulk Delete","pages":[{"title":"Delete Users and Companies","sidebarTitle":"Overview","href":"/api-references/delete/overview"}]}]}]},"title":"Welcome to Userpilot Documentation - Userpilot Knowledge Base","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}