> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userplane.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to Userplane documentation

# Welcome to Userplane

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.

## How it works

<Steps>
  <Step title="Send a recording link">
    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.

    <Frame caption="Create a recording link">
      <img src="https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-empty.png?fit=max&auto=format&n=iHJrxtyvOmNXmfMS&q=85&s=731b5f63c5f203bde57e16fa33bb93f8" width="2940" height="1492" data-path="media/links/create-link/create-link-empty.png" />
    </Frame>
  </Step>

  <Step title="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.

    <Frame caption="Customer records their screen">
      <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recorder/recording-upload-inprogress.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=b71dafe67d3c44790a002f83ea8bdd99" width="1920" height="958" data-path="media/recorder/recording-upload-inprogress.png" />
    </Frame>
  </Step>

  <Step title="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.

    <Frame caption="Recording playback view">
      <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-detail.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=2397d88b5959cb8c84f86a9c033ea3e0" width="2940" height="1492" data-path="media/recordings/recording-detail.png" />
    </Frame>
  </Step>
</Steps>

## Jump in

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Create your first recording link and start capturing issues in minutes
  </Card>

  <Card title="Recordings" icon="circle-dot" href="/recording/requesting">
    Request, review, and share session recordings with your team
  </Card>

  <Card title="Web SDK" icon="code" href="/developer/web-sdk">
    Integrate Userplane programmatically into your app
  </Card>

  <Card title="Integrations" icon="plug" href="/getting-started/helpdesk-setup">
    Connect Userplane with Intercom, Zendesk, Slack, the Chrome extension, and your support tools
  </Card>

  <Card title="AI Agents" icon="robot" href="/integrations/mcp">
    Connect Claude, Cursor, Codex, VS Code, or ChatGPT to analyze recordings, search docs, or use
    Userplane agent plugins for automated integration
  </Card>
</CardGroup>

## Explore by role

<CardGroup cols={3}>
  <Card title="Support Agents" icon="headset" href="/getting-started/for-support-agents">
    Send recording links via Intercom, Zendesk, Slack, or the Chrome extension, and use shortcuts
    and macros
  </Card>

  <Card title="Support Engineers" icon="gear" href="/getting-started/for-support-engineers">
    Configure your workspace, verify domains, manage permissions, and set up redaction
  </Card>

  <Card title="Developers" icon="terminal" href="/getting-started/for-developers">
    Install the SDK, attach metadata, configure redaction, and integrate with your framework
  </Card>
</CardGroup>

## What gets captured

<CardGroup cols={2}>
  <Card title="Screen Video" icon="video">
    Full screen recording of the customer's browser session, exactly as they experienced it
  </Card>

  <Card title="Console Logs" icon="rectangle-terminal">
    JavaScript errors, warnings, and log output captured in sync with the video timeline
  </Card>

  <Card title="Network Activity" icon="network-wired">
    HTTP requests and responses, including status codes, headers, and timing
  </Card>

  <Card title="User Actions" icon="cursor-arrow-rays">
    Clicks, scrolls, navigation events, and form interactions annotated on the timeline
  </Card>

  <Card title="Audio" icon="microphone">
    Optional microphone capture so customers can narrate the issue as they record
  </Card>

  <Card title="Custom Metadata" icon="tag">
    Attach user IDs, account data, and app state via the SDK for richer context
  </Card>
</CardGroup>