Click the “Publish” button in the dashboard to get your project ID and API key (if applicable).See the Integration Guide for full implementation details.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Pop Onboarding","colors":{"primary":"#0F172A","light":"#3B82F6","dark":"#0F172A"},"logo":{"light":"https://mintcdn.com/poponboarding/j0e9l0QyWAqsASUs/logo/light.png?fit=max\u0026auto=format\u0026n=j0e9l0QyWAqsASUs\u0026q=85\u0026s=d4f2da07b88830a2d7e82f78a1980461","dark":"https://mintcdn.com/poponboarding/j0e9l0QyWAqsASUs/logo/dark.png?fit=max\u0026auto=format\u0026n=j0e9l0QyWAqsASUs\u0026q=85\u0026s=1089d90f481fe09247f367b91b78c887"},"favicon":"/favicon.png","navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"poponboarding","hasAudioNarration":false,"actualSubdomain":"poponboarding","customDomains":["docs.poponboarding.com"],"gitSource":{"type":"github","owner":"jamesagib","repo":"pop-onboarding","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20cf43cbe1d91069f22867","collectionId":"eecca513-3b12-4a25-bee6-e6a2223de630","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20cf43cbe1d91069f22867:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Essentials","count":2},{"language":"default","tag":"Get Started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"quickstart","slug":"/quickstart","pageMetadata":{"title":"Quickstart","description":"Get started with Pop Onboarding in under 5 minutes","href":"/quickstart"},"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: \"Get started with Pop Onboarding in under 5 minutes\"\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`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`1-create-a-project`,children:`1. Create a Project`}),`\n`,_jsxs(_components.p,{children:[`Sign up at `,_jsx(_components.a,{href:`https://poponboarding.com`,children:`poponboarding.com`}),` and create a new project. You can start from a blank canvas or use one of our high-converting templates.`]}),`\n`,_jsx(Heading,{level:`2`,id:`2-design-your-flow`,children:`2. Design Your Flow`}),`\n`,_jsx(_components.p,{children:`Use the visual editor to add screens, buttons, images, and text. Customize colors and fonts to match your brand.`}),`\n`,_jsx(Heading,{level:`2`,id:`3-install-the-sdk`,children:`3. Install the SDK`}),`\n`,_jsx(_components.p,{children:`Add the SDK to your mobile application.`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`React Native`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` react-native-pop-onboarding`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Swift`,numberOfLines:`2`,language:`swift`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`swift`,children:_jsxs(_components.code,{language:`swift`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Add Package Dependency:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// https://github.com/jamesagib/pop-onboarding-swift`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`4-copy-your-code`,children:`4. Copy Your Code`}),`\n`,_jsxs(_components.p,{children:[`Click the `,_jsx(_components.strong,{children:`“Publish”`}),` button in the dashboard to get your project ID and API key (if applicable).`]}),`\n`,_jsxs(_components.p,{children:[`See the `,_jsx(_components.a,{href:`/essentials/webview-integration`,children:`Integration Guide`}),` for full implementation details.`]})]})}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":"Quickstart","description":"Get started with Pop Onboarding in under 5 minutes","href":"/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"1. Create a Project","slug":"1-create-a-project","depth":2,"children":[]},{"title":"2. Design Your Flow","slug":"2-design-your-flow","depth":2,"children":[]},{"title":"3. Install the SDK","slug":"3-install-the-sdk","depth":2,"children":[]},{"title":"4. Copy Your Code","slug":"4-copy-your-code","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"poponboarding","siteName":"Pop Onboarding","title":"Quickstart - Pop Onboarding","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-18T05:16:39.396Z","originalFileLocation":"quickstart.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=\"Get started with Pop Onboarding in under 5 minutes\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pop Onboarding\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/poponboarding/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/poponboarding/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/poponboarding/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/poponboarding/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Pop Onboarding\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get started with Pop Onboarding in under 5 minutes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pop Onboarding\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.poponboarding.com/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://poponboarding.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Quickstart\u0026amp;description=Get+started+with+Pop+Onboarding+in+under+5+minutes\u0026amp;theme=eaa7d6c4bb794b65cbffcc85\u0026amp;signature=da95a7e912aa6e2a0ca1b0dac1e96222749c26ad0810f00453a1849d3b4d41ed\">\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=\"Quickstart - Pop Onboarding\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get started with Pop Onboarding in under 5 minutes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://poponboarding.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Quickstart\u0026amp;description=Get+started+with+Pop+Onboarding+in+under+5+minutes\u0026amp;theme=eaa7d6c4bb794b65cbffcc85\u0026amp;signature=da95a7e912aa6e2a0ca1b0dac1e96222749c26ad0810f00453a1849d3b4d41ed\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/poponboarding/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pop Onboarding\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F172A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.poponboarding.com/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.poponboarding.com/#organization\",\"name\":\"Pop Onboarding\",\"url\":\"https://docs.poponboarding.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/poponboarding/j0e9l0QyWAqsASUs/logo/light.png?fit=max\u0026auto=format\u0026n=j0e9l0QyWAqsASUs\u0026q=85\u0026s=d4f2da07b88830a2d7e82f78a1980461\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.poponboarding.com#website\",\"name\":\"Pop Onboarding\",\"url\":\"https://docs.poponboarding.com\",\"publisher\":{\"@id\":\"https://docs.poponboarding.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.poponboarding.com/quickstart#webpage\",\"url\":\"https://docs.poponboarding.com/quickstart\",\"name\":\"Quickstart\",\"description\":\"Get started with Pop Onboarding in under 5 minutes\",\"dateModified\":\"2025-12-18T05:16:39.396Z\",\"isPartOf\":{\"@id\":\"https://docs.poponboarding.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.poponboarding.com/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.poponboarding.com/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.poponboarding.com/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.poponboarding.com/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.poponboarding.com/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Get started with Pop Onboarding in under 5 minutes\",\"url\":\"https://docs.poponboarding.com/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.poponboarding.com/quickstart#webpage\"},\"dateModified\":\"2025-12-18T05:16:39.396Z\",\"publisher\":{\"@id\":\"https://docs.poponboarding.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.poponboarding.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pop Onboarding\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pop Onboarding","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","description":"Ship native mobile onboarding flows without App Store updates","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Essentials","pages":[{"title":"WebView Integration","description":"Integrate onboarding flows into native iOS and Android apps","href":"/essentials/webview-integration"},{"title":"Notification Permissions","href":"/essentials/notification-permissions"}]}]},"basePath":"","title":"Quickstart - Pop Onboarding","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}