> ## 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.

# Quickstart

> Get up and running with Userplane — create a recording link, send it to a customer, and see exactly what went wrong.

Userplane helps your support team request screen recordings from customers in just a few seconds. Instead of asking customers to describe what went wrong, you can send them a simple link and get a full video of the issue, complete with console logs, network activity, and more.

## How it works

1. **Create a recording link** — pick a project, domain, and optional reference from the dashboard or the [Chrome extension](/integrations/chrome-extension), then share the link with your customer.
2. **Customer records** — your customer opens the link in their browser and records their screen. No installs or extensions needed.
3. **Review the recording** — watch the video and inspect console errors, network requests, client actions, and any custom metadata.

## Create your first recording link

<Steps>
  <Step title="Open the Create Link dialog">
    Click [Create Link](https://dash.userplane.io/_/recordings?create_link=true) in the top right of
    the navbar.

    <Frame caption="Create Link dialog">
      <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="Fill in the link details">
    * **Project** — choose which project this recording belongs to. - **Domain** — select a verified
      domain to brand the link with your site's identity (optional but recommended). - **Reference** —
      add an external reference like a ticket number or URL (e.g. `JIRA-456`). - **Reusable** — toggle
      whether the link can be used once or multiple times.

    <Frame caption="Filled Create Link form">
      <img src="https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/create-link/create-link-filled.png?fit=max&auto=format&n=iHJrxtyvOmNXmfMS&q=85&s=0086b062a05b5dc7b21a3ec1f9405946" width="2940" height="1492" data-path="media/links/create-link/create-link-filled.png" />
    </Frame>
  </Step>

  <Step title="Share the link">
    Click **Create** and copy the link. Send it to your customer through chat, email, or a help desk
    macro.

    <Frame caption="Share the link">
      <img src="https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/links/share-link/share-link-modal.png?fit=max&auto=format&n=iHJrxtyvOmNXmfMS&q=85&s=076a3ada7385260c7542830d9002b6ed" width="1920" height="957" data-path="media/links/share-link/share-link-modal.png" />
    </Frame>
  </Step>
</Steps>

## Review a recording

<Steps>
  <Step title="Open the Recordings page">
    Go to [Recordings](https://dash.userplane.io/_/recordings) from the sidebar.
  </Step>

  <Step title="Find the recording">
    Browse recordings in the grid view, or filter by project, member, or link.

    <Frame caption="Recordings list">
      <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recordings-list.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=0dc33f03c4f60e84f7d6ab1a019e64bb" width="2940" height="1492" data-path="media/recordings/recordings-list.png" />
    </Frame>
  </Step>

  <Step title="Inspect the details">
    Click a recording to open the detail view. Use the right-hand tabs to dig into:

    | Tab         | What it shows                                                      |
    | ----------- | ------------------------------------------------------------------ |
    | **Info**    | Link details, customer notes, system metadata, and custom metadata |
    | **Console** | Browser console logs including errors, warnings, and messages      |
    | **Network** | HTTP requests with timing and status codes                         |
    | **Actions** | Clicks, inputs, and page navigations                               |
    | **Backend** | Server-side logs if you've configured them                         |

    <Frame caption="Recording detail 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>

    <Frame caption="Console logs panel">
      <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/recordings/recording-console-tab.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=fbc70251ceaee205cd3f3118239e3946" width="2580" height="1492" data-path="media/recordings/recording-console-tab.png" />
    </Frame>

    <Frame caption="Network logs panel">
      <img src="https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/playback/network/network-panel-list-view.png?fit=max&auto=format&n=iHJrxtyvOmNXmfMS&q=85&s=a6f970197afe084739ad82a0996fbd99" width="1920" height="958" data-path="media/playback/network/network-panel-list-view.png" />
    </Frame>

    <Frame caption="Action logs panel">
      <img src="https://mintcdn.com/userplane/iHJrxtyvOmNXmfMS/media/playback/actions/actions-list-view.png?fit=max&auto=format&n=iHJrxtyvOmNXmfMS&q=85&s=648d0c27d24049f06610735f8bbfe212" width="1920" height="958" data-path="media/playback/actions/actions-list-view.png" />
    </Frame>
  </Step>
</Steps>

## What gets captured

Every recording includes a video of your customer's screen. Depending on your [domain recording preferences](/recording-links/domain-preferences), you can also capture:

* Browser console logs
* Network request and response data
* Client-side actions (clicks, inputs, navigation)
* Server-side and backend logs
* Voice and device audio (when enabled)
* Customer notes
* System metadata (browser, OS, page URL)

Sensitive data can be automatically redacted to keep things secure. See [Sensitive Data Redaction](/recording-links/sensitive-data-redaction) for more details.

## Next steps

* [Set up your workspace](/getting-started/workspace-setup) — invite your teammates and configure settings.
* [Connect your help desk](/getting-started/helpdesk-setup) — request recordings directly from Intercom, Zendesk, or Slack, or install the [Chrome extension](/integrations/chrome-extension) to work alongside any help desk.
* [Customize your recording links](/recording-links/overview) — add your branding and configure what gets captured.