Userplane helps your support team request screen recordings from customers in seconds. Instead of asking customers to describe what went wrong, send them a simple link and get a full video of the issue — complete with console logs, network activity, and more.
Create a recording link from your dashboard, the Chrome extension, or directly inside an Intercom,
Zendesk, or Slack conversation. Share it with your customer via chat, email, or any support channel.
Create a recording link
2
Customer records their screen
The customer clicks the link, records their screen in one click — no installs, no sign-up
required. Audio and browser activity are captured automatically.
Customer records their screen
3
Review the full session
Watch the video alongside synchronized console logs, network requests, and user actions. Use the
Issue Analyzer to surface root causes instantly.
Full screen recording of the customer’s browser session, exactly as they experienced it
Console Logs
JavaScript errors, warnings, and log output captured in sync with the video timeline
Network Activity
HTTP requests and responses, including status codes, headers, and timing
User Actions
Clicks, scrolls, navigation events, and form interactions annotated on the timeline
Audio
Optional microphone capture so customers can narrate the issue as they record
Custom Metadata
Attach user IDs, account data, and app state via the SDK for richer context
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Userplane Docs","colors":{"primary":"#000000","light":"#FAFAFA","dark":"#000000"},"logo":{"light":"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/logo-light.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=b60f979b7800d446f3f5d5274c095cb2","dark":"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/logo-dark.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=f638b932d019423317aaca6685f22ea6"},"favicon":"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/favicon.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=fd9fbcc5e1783343c767381ce1744d03","api":{"playground":{"display":"interactive"}},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dash.userplane.io"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"userplane","hasAudioNarration":false,"actualSubdomain":"userplane","customDomains":["docs.userplane.io"],"gitSource":{"type":"github","owner":"0xnyn","repo":"userplane","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eb6f2fb2a99bab92da64","collectionId":"8e53ea74-03f5-4b56-ab3a-aff2a4fe9720","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eb6f2fb2a99bab92da64:success","clientVersion":"0.0.3908","searchFilterCounts":[{"language":"default","tag":"Integrations","count":62},{"language":"default","tag":"Guide","count":47},{"language":"default","tag":"Extensions \u0026 Plugins","count":34},{"language":"default","tag":"API","count":28},{"language":"default","tag":"Developer","count":24},{"language":"default","tag":"Recordings","count":21},{"language":"default","tag":"Help Desk","count":16},{"language":"default","tag":"Claude Code","count":14},{"language":"default","tag":"Framework Guides","count":13},{"language":"default","tag":"Getting Started","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Introduction","description":"Welcome to Userplane documentation","href":"/introduction"},"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: \"Welcome to Userplane documentation\"\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={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Frame,Heading,OptimizedImage,Step,Steps}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`welcome-to-userplane`,children:`Welcome to Userplane`}),`\n`,_jsx(_components.p,{children:`Userplane helps your support team request screen recordings from customers in seconds. Instead of asking customers to describe what went wrong, send them a simple link and get a full video of the issue — complete with console logs, network activity, and more.`}),`\n`,_jsx(Heading,{level:`2`,id:`how-it-works`,children:`How it works`}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Send a recording link`,children:[_jsx(_components.p,{children:`Create a recording link from your dashboard, the Chrome extension, or directly inside an Intercom,\nZendesk, or Slack conversation. Share it with your customer via chat, email, or any support channel.`}),_jsx(Frame,{caption:`Create a recording link`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=731b5f63c5f203bde57e16fa33bb93f8`,\"data-og-width\":`2940`,width:`2940`,\"data-og-height\":`1492`,height:`1492`,\"data-path\":`media/links/create-link/create-link-empty.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?w=280\u0026fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=eacbbb67249cb58d79a9dde44c5af18e 280w, https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?w=560\u0026fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=1dd4a27ea3017b5bcb727f5d874999ab 560w, https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?w=840\u0026fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=1cb832a52eba5b86e26b01051ba25ffc 840w, https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?w=1100\u0026fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=c2eea391e192f4438659e441fcfd2e69 1100w, https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?w=1650\u0026fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=7cf75393f25e4bb704d8fe9f6eb02f72 1650w, https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?w=2500\u0026fit=max\u0026auto=format\u0026n=iHJrxtyvOmNXmfMS\u0026q=85\u0026s=a2e47e4dc087541e1a966fe27205f063 2500w`})})]}),_jsxs(Step,{title:`Customer records their screen`,children:[_jsx(_components.p,{children:`The customer clicks the link, records their screen in one click — no installs, no sign-up\nrequired. Audio and browser activity are captured automatically.`}),_jsx(Frame,{caption:`Customer records their screen`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=b71dafe67d3c44790a002f83ea8bdd99`,\"data-og-width\":`1920`,width:`1920`,\"data-og-height\":`958`,height:`958`,\"data-path\":`media/recorder/recording-upload-inprogress.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?w=280\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=ed3dc9b55563cafb41ff0c70d10b3651 280w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?w=560\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=c93413df071a87732c602f67707faa4f 560w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?w=840\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=b7a519d3f1985ac578327c1ea73c077f 840w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?w=1100\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=feb14a3c56c7e43208fe852150659241 1100w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?w=1650\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=e9dbce18448cf37f1251d0597604fd16 1650w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?w=2500\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=915e0db4968ae2db03a31fae5f79f704 2500w`})})]}),_jsxs(Step,{title:`Review the full session`,children:[_jsx(_components.p,{children:`Watch the video alongside synchronized console logs, network requests, and user actions. Use the\nIssue Analyzer to surface root causes instantly.`}),_jsx(Frame,{caption:`Recording playback view`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=2397d88b5959cb8c84f86a9c033ea3e0`,\"data-og-width\":`2940`,width:`2940`,\"data-og-height\":`1492`,height:`1492`,\"data-path\":`media/recordings/recording-detail.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?w=280\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=48e89a6e4ebe7921fd171cf13ec6b843 280w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?w=560\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=dbd011344309eb8074db05d83a48c0b4 560w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?w=840\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=13a17b352e8d303b16d1a6f788eb05b4 840w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?w=1100\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=75debfef55f4dcebb21f5dd0a6dc7e35 1100w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?w=1650\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=82e2fe3639dd5d87cc563c2c18160269 1650w, https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?w=2500\u0026fit=max\u0026auto=format\u0026n=IKCB4f_KBaL0xsjW\u0026q=85\u0026s=61b06c5c240da23bc35f7248f2f18c6b 2500w`})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`jump-in`,children:`Jump in`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Quickstart`,icon:`rocket`,href:`/quickstart`,children:_jsx(_components.p,{children:`Create your first recording link and start capturing issues in minutes`})}),_jsx(Card,{title:`Recordings`,icon:`circle-dot`,href:`/recording/requesting`,children:_jsx(_components.p,{children:`Request, review, and share session recordings with your team`})}),_jsx(Card,{title:`Web SDK`,icon:`code`,href:`/developer/web-sdk`,children:_jsx(_components.p,{children:`Integrate Userplane programmatically into your app`})}),_jsx(Card,{title:`Integrations`,icon:`plug`,href:`/getting-started/helpdesk-setup`,children:_jsx(_components.p,{children:`Connect Userplane with Intercom, Zendesk, Slack, the Chrome extension, and your support tools`})}),_jsx(Card,{title:`AI Agents`,icon:`robot`,href:`/integrations/mcp`,children:_jsx(_components.p,{children:`Connect Claude, Cursor, Codex, VS Code, or ChatGPT to analyze recordings, search docs, or use\nUserplane agent plugins for automated integration`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`explore-by-role`,children:`Explore by role`}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsx(Card,{title:`Support Agents`,icon:`headset`,href:`/getting-started/for-support-agents`,children:_jsx(_components.p,{children:`Send recording links via Intercom, Zendesk, Slack, or the Chrome extension, and use shortcuts\nand macros`})}),_jsx(Card,{title:`Support Engineers`,icon:`gear`,href:`/getting-started/for-support-engineers`,children:_jsx(_components.p,{children:`Configure your workspace, verify domains, manage permissions, and set up redaction`})}),_jsx(Card,{title:`Developers`,icon:`terminal`,href:`/getting-started/for-developers`,children:_jsx(_components.p,{children:`Install the SDK, attach metadata, configure redaction, and integrate with your framework`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`what-gets-captured`,children:`What gets captured`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Screen Video`,icon:`video`,children:_jsx(_components.p,{children:`Full screen recording of the customer’s browser session, exactly as they experienced it`})}),_jsx(Card,{title:`Console Logs`,icon:`rectangle-terminal`,children:_jsx(_components.p,{children:`JavaScript errors, warnings, and log output captured in sync with the video timeline`})}),_jsx(Card,{title:`Network Activity`,icon:`network-wired`,children:_jsx(_components.p,{children:`HTTP requests and responses, including status codes, headers, and timing`})}),_jsx(Card,{title:`User Actions`,icon:`cursor-arrow-rays`,children:_jsx(_components.p,{children:`Clicks, scrolls, navigation events, and form interactions annotated on the timeline`})}),_jsx(Card,{title:`Audio`,icon:`microphone`,children:_jsx(_components.p,{children:`Optional microphone capture so customers can narrate the issue as they record`})}),_jsx(Card,{title:`Custom Metadata`,icon:`tag`,children:_jsx(_components.p,{children:`Attach user IDs, account data, and app state via the SDK for richer context`})})]})]})}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":"Introduction","description":"Welcome to Userplane documentation","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome to Userplane","slug":"welcome-to-userplane","depth":1,"children":[]},{"title":"How it works","slug":"how-it-works","depth":2,"children":[]},{"title":"Jump in","slug":"jump-in","depth":2,"children":[]},{"title":"Explore by role","slug":"explore-by-role","depth":2,"children":[]},{"title":"What gets captured","slug":"what-gets-captured","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/userplane/95cb985acf23057a/eslint.config.js"],"subdomain":"userplane","siteName":"Userplane Docs","title":"Introduction - Userplane Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-06T18:42:38.411Z","originalFileLocation":"introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Welcome to Userplane documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Userplane Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Userplane Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to Userplane documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userplane Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userplane.io/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Userplane Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to Userplane documentation\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/userplane/fDBjjV0nXQ3P7r2U/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Userplane Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userplane.io/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.userplane.io/#organization\",\"name\":\"Userplane Docs\",\"url\":\"https://docs.userplane.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/logo-light.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=b60f979b7800d446f3f5d5274c095cb2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.userplane.io#website\",\"name\":\"Userplane Docs\",\"url\":\"https://docs.userplane.io\",\"publisher\":{\"@id\":\"https://docs.userplane.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.userplane.io/introduction#webpage\",\"url\":\"https://docs.userplane.io/introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to Userplane documentation\",\"dateModified\":\"2026-05-06T18:42:38.411Z\",\"isPartOf\":{\"@id\":\"https://docs.userplane.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userplane.io/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userplane.io/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Userplane Docs\",\"item\":\"https://docs.userplane.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.userplane.io/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.userplane.io/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to Userplane documentation\",\"url\":\"https://docs.userplane.io/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userplane.io/introduction#webpage\"},\"dateModified\":\"2026-05-06T18:42:38.411Z\",\"publisher\":{\"@id\":\"https://docs.userplane.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.userplane.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Userplane Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Userplane Docs","nav":{"global":null,"tabs":[{"tab":"Guide","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","description":"Get up and running with Userplane — create a recording link, send it to a customer, and see exactly what went wrong.","href":"/quickstart"}]},{"group":"Setup \u0026 Onboarding","icon":"wrench","pages":[{"title":"Workspace Setup","href":"/getting-started/workspace-setup"},{"title":"Help Desk Setup","href":"/getting-started/helpdesk-setup"},{"title":"Support Agent Onboarding","href":"/getting-started/for-support-agents"},{"title":"Support Engineer Onboarding","href":"/getting-started/for-support-engineers"},{"title":"Developer Onboarding","href":"/getting-started/for-developers"}]},{"group":"Recordings","icon":"video","pages":[{"group":"Capture","pages":[{"title":"Requesting a Recording","href":"/recording/requesting"},{"title":"Reusable Recording Links","href":"/recording-links/reusable"},{"title":"Link Reference","href":"/recording/link-reference"},{"title":"Recording Domains","href":"/recording/domains"}]},{"group":"Review","pages":[{"title":"Reviewing Recordings","href":"/recording/reviewing"},{"title":"Recording Playback","href":"/recording/playback"},{"title":"Issue Analyzer","href":"/recording/issue-analyzer"},{"title":"Sharing Recordings","href":"/recording/sharing"},{"title":"Recording Expiry","href":"/recording/expiry"},{"title":"Recording Projects","href":"/recording/projects"}]},{"group":"Link Settings","pages":[{"title":"Managing Recording Links","href":"/recording-links/managing"},{"title":"Customizing Recording Links","href":"/recording-links/overview"},{"title":"Branding Your Links","href":"/recording-links/branding"},{"title":"Domain Recording Preferences","href":"/recording-links/domain-preferences"},{"title":"Recording Limits \u0026 Duration","href":"/recording-links/limits"},{"title":"Sensitive Data Redaction","href":"/recording-links/sensitive-data-redaction"},{"title":"Recording Link Metadata","href":"/recording-links/link-metadata"}]}]},{"group":"Workspace","icon":"building","pages":[{"group":"Team \u0026 Access","pages":[{"title":"Team Management","href":"/workspace/team-management"},{"title":"Roles \u0026 Permissions","href":"/workspace/roles-permissions"},{"title":"Invite Policies","href":"/workspace/invite-policies"},{"title":"Access Management","href":"/workspace/access-management"}]},{"group":"Projects","pages":[{"title":"Projects","href":"/workspace/projects"},{"title":"Project Lifecycle","href":"/workspace/project-lifecycle"}]},{"group":"Domains","pages":[{"title":"Domains","href":"/workspace/domains"},{"title":"Managing Domains","href":"/workspace/domain-management"},{"title":"Domain Verification","href":"/workspace/domain-verification"}]},{"title":"Workspace Lifecycle","href":"/workspace/workspace-lifecycle"}]},{"group":"Account","icon":"circle-user","pages":[{"title":"Updating Your Profile","href":"/account/profile"},{"title":"Notification Channels \u0026 Preferences","href":"/account/notifications"},{"title":"Connected Apps","href":"/account/connections"},{"title":"Leaving a Workspace","href":"/account/leaving-workspace"}]},{"group":"Billing","icon":"credit-card","pages":[{"title":"Subscription Overview","href":"/billing/overview"},{"title":"Trial Plans","href":"/billing/trial"},{"group":"Plans \u0026 Usage","pages":[{"title":"Understanding Usage Limits","href":"/billing/usage-limits"},{"title":"Monitoring Your Usage","href":"/billing/monitoring-usage"},{"title":"Upgrading Your Plan","href":"/billing/upgrading"},{"title":"Downgrading Your Plan","href":"/billing/downgrading"},{"title":"Seat Add-Ons","href":"/billing/seat-add-ons"}]}]},{"group":"Support","icon":"life-ring","pages":[{"title":"Contact Us","href":"/support/contact"},{"title":"Data \u0026 Governance","href":"/support/data-governance"}]}]},{"tab":"Developer","pages":[{"title":"Developer","href":"/developer/installation"}]},{"tab":"API","pages":[{"title":"API","href":"/api/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/intercom"}]}]},"title":"Introduction - Userplane Docs","buildId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","deploymentId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-BCFzRGe_.js","DynamicMarkdown-BUuAYxJE.js","zoom-image-lightbox-DQ5W4Q2v.js","PlusIcon-jZ8vgk6R.js","lightbox-handle-r17bVUz3.js"]}
