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

# Zendesk Integration

> Connect Userplane to Zendesk for in-ticket screen recording requests

The Zendesk integration lets your support team request and review screen recordings directly from Zendesk tickets. Agents can create recording links, insert them into replies, and get notified when recordings arrive — all without leaving Zendesk.

## What the integration does

* Installs a **ticket sidebar app** for creating recording links and viewing recordings.
* Adds a **ticket editor button** so agents can insert recording links directly into reply drafts.
* Adds a **top bar app** for quick link creation from anywhere in Zendesk.
* Automatically **tags tickets** with `userplane-recording-requested` when a link is created.
* Posts **internal notes** to tickets when recordings are received.
* Captures **ticket context** — ID, subject, priority, type, tags, and requester info — with each recording link.

## Connecting Zendesk

There are two ways to connect Userplane to Zendesk — create a new workspace during setup or connect an existing one:

<Note>Only workspace **owners** and **admins** can authorize the Zendesk connection.</Note>

<Tabs>
  <Tab title="Create a new workspace">
    Install the Zendesk app and create a new Userplane workspace during the authorization flow.

    <Steps>
      <Step title="Install from the Zendesk Marketplace">
        Find Userplane in the [Zendesk Marketplace](https://www.zendesk.com/marketplace/apps/support/1229987/screen-recording-by-userplane/) and install it to your Zendesk account.

        <Frame caption="Zendesk Marketplace install">
          <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/marketplace/post-install-view.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=a298b67d4cb21ae31f9ba27631100c35" width="1920" height="957" data-path="media/zendesk/zendesk-app/marketplace/post-install-view.png" />
        </Frame>
      </Step>

      <Step title="Open the Userplane app">
        Open any ticket in Zendesk and click the **Userplane** app in the ticket sidebar to start the authorization flow.

        <Frame caption="Sidebar opener">
          <img src="https://mintcdn.com/userplane/_qXbmO6IuSeHLGEc/media/zendesk/zendesk-oauth/zendesk-connect-workspace.png?fit=max&auto=format&n=_qXbmO6IuSeHLGEc&q=85&s=a00a21df02110539234fa67022d335ca" width="2940" height="1596" data-path="media/zendesk/zendesk-oauth/zendesk-connect-workspace.png" />
        </Frame>
      </Step>

      <Step title="Create a workspace">
        Click **Connect to Userplane** and choose to create a new workspace.

        <Frame caption="Create a workspace">
          <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-oauth/zendesk-create-workspace.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=e8dbe95d3eb88685e6dfa028990ba2ee" width="1920" height="958" data-path="media/zendesk/zendesk-oauth/zendesk-create-workspace.png" />
        </Frame>
      </Step>

      <Step title="Invite teammates">
        Invite your support team to the new Userplane workspace.

        <Frame caption="Invite teammates">
          <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-oauth/post-onboarding-invite-teammates.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=61f24736f786310a7e1178d5142e9b98" width="1920" height="959" data-path="media/zendesk/zendesk-oauth/post-onboarding-invite-teammates.png" />
        </Frame>
      </Step>

      <Step title="Review your setup">
        Confirm the integration is connected in your workspace settings.

        <Frame caption="Integration connected">
          <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-oauth/post-onboarding-settings-preview.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=b13d2e90d72ffed4283dd4b087f9c0f6" width="1920" height="958" data-path="media/zendesk/zendesk-oauth/post-onboarding-settings-preview.png" />
        </Frame>
      </Step>

      <Step title="Refresh the Zendesk app">
        Go back to the Zendesk app and click **Refresh** to pick up the newly connected workspace.

        <Frame caption="Complete sign-in">
          <img src="https://mintcdn.com/userplane/_qXbmO6IuSeHLGEc/media/zendesk/zendesk-oauth/zendesk-complete-sign-in.png?fit=max&auto=format&n=_qXbmO6IuSeHLGEc&q=85&s=1ca98e8471539bd2bcdbdff2217249d9" width="2820" height="1596" data-path="media/zendesk/zendesk-oauth/zendesk-complete-sign-in.png" />
        </Frame>
      </Step>

      <Step title="Start using the integration">
        The Userplane app is now available across Zendesk — ticket sidebar, ticket editor, and top bar.

        <Tabs>
          <Tab title="Sidebar">
            <Frame caption="Zendesk sidebar app">
              <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/sidebar/create-link-form.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=9d191afbcda23d0ff911398d50d6cb95" width="1920" height="956" data-path="media/zendesk/zendesk-app/sidebar/create-link-form.png" />
            </Frame>
          </Tab>

          <Tab title="Editor">
            <Frame caption="Zendesk editor button">
              <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/editor/create-link-form.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=39861d9625f03fa8c8b6d5a8c5d97952" width="1920" height="956" data-path="media/zendesk/zendesk-app/editor/create-link-form.png" />
            </Frame>
          </Tab>

          <Tab title="Top bar">
            <Frame caption="Zendesk top bar app">
              <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/navbar/opener-view.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=48ca4b4e83137a92c0199a0df15cc0d6" width="1920" height="957" data-path="media/zendesk/zendesk-app/navbar/opener-view.png" />
            </Frame>
          </Tab>
        </Tabs>
      </Step>
    </Steps>
  </Tab>

  <Tab title="Connect an existing workspace">
    If you already have a Userplane workspace, install the Zendesk app and connect it to your existing workspace.

    <Steps>
      <Step title="Install from the Zendesk Marketplace">
        Find Userplane in the [Zendesk Marketplace](https://www.zendesk.com/marketplace/apps/support/1229987/screen-recording-by-userplane/) and install it to your Zendesk account.

        <Frame caption="Zendesk Marketplace install">
          <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/marketplace/post-install-view.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=a298b67d4cb21ae31f9ba27631100c35" width="1920" height="957" data-path="media/zendesk/zendesk-app/marketplace/post-install-view.png" />
        </Frame>
      </Step>

      <Step title="Open the Userplane app">
        Open any ticket in Zendesk and click the **Userplane** app in the ticket sidebar to start the authorization flow.

        <Frame caption="Sidebar opener">
          <img src="https://mintcdn.com/userplane/_qXbmO6IuSeHLGEc/media/zendesk/zendesk-oauth/zendesk-connect-workspace.png?fit=max&auto=format&n=_qXbmO6IuSeHLGEc&q=85&s=a00a21df02110539234fa67022d335ca" width="2940" height="1596" data-path="media/zendesk/zendesk-oauth/zendesk-connect-workspace.png" />
        </Frame>
      </Step>

      <Step title="Select your workspace">
        Complete the sign-in in the popup window and select your existing workspace from the list.

        <Frame caption="Select your workspace">
          <img src="https://mintcdn.com/userplane/_qXbmO6IuSeHLGEc/media/zendesk/zendesk-oauth/zendesk-workspace-selector.png?fit=max&auto=format&n=_qXbmO6IuSeHLGEc&q=85&s=9174ed2fe8c81d766b11873aa108bf43" width="2940" height="1596" data-path="media/zendesk/zendesk-oauth/zendesk-workspace-selector.png" />
        </Frame>
      </Step>

      <Step title="Refresh the Zendesk app">
        Go back to the Zendesk app and click **Refresh** to pick up the newly connected workspace.

        <Frame caption="Complete sign-in">
          <img src="https://mintcdn.com/userplane/_qXbmO6IuSeHLGEc/media/zendesk/zendesk-oauth/zendesk-complete-sign-in.png?fit=max&auto=format&n=_qXbmO6IuSeHLGEc&q=85&s=1ca98e8471539bd2bcdbdff2217249d9" width="2820" height="1596" data-path="media/zendesk/zendesk-oauth/zendesk-complete-sign-in.png" />
        </Frame>
      </Step>

      <Step title="Review your setup">
        Confirm the integration is connected in your workspace settings.

        <Frame caption="Integrations — connected">
          <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/zendesk/workspace-settings/post-connection-modal.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=df3e16b30f9ebd74da4e20d8dcf3cd93" width="1920" height="958" data-path="media/zendesk/workspace-settings/post-connection-modal.png" />
        </Frame>
      </Step>

      <Step title="Start using the integration">
        The Userplane app is now available across Zendesk — ticket sidebar, ticket editor, and top bar.

        <Tabs>
          <Tab title="Sidebar">
            <Frame caption="Zendesk sidebar app">
              <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/sidebar/create-link-form.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=9d191afbcda23d0ff911398d50d6cb95" width="1920" height="956" data-path="media/zendesk/zendesk-app/sidebar/create-link-form.png" />
            </Frame>
          </Tab>

          <Tab title="Editor">
            <Frame caption="Zendesk editor button">
              <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/editor/create-link-form.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=39861d9625f03fa8c8b6d5a8c5d97952" width="1920" height="956" data-path="media/zendesk/zendesk-app/editor/create-link-form.png" />
            </Frame>
          </Tab>

          <Tab title="Top bar">
            <Frame caption="Zendesk top bar app">
              <img src="https://mintcdn.com/userplane/egKmOMA4so9foWLy/media/zendesk/zendesk-app/navbar/opener-view.png?fit=max&auto=format&n=egKmOMA4so9foWLy&q=85&s=48ca4b4e83137a92c0199a0df15cc0d6" width="1920" height="957" data-path="media/zendesk/zendesk-app/navbar/opener-view.png" />
            </Frame>
          </Tab>
        </Tabs>
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Permissions granted

When you authorize the Zendesk connection, Userplane receives the following permissions:

* Read ticket data to capture context and associate recordings with tickets.
* Manage ticket tags to mark tickets with `userplane-recording-requested`.
* Post internal comments to notify agents when recordings arrive.

<Frame caption="Zendesk connected">
  <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/zendesk/workspace-settings/post-connection-modal.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=df3e16b30f9ebd74da4e20d8dcf3cd93" width="1920" height="958" data-path="media/zendesk/workspace-settings/post-connection-modal.png" />
</Frame>

## Disconnecting Zendesk

<Steps>
  <Step title="Open Integrations settings">
    Go to [Workspace Settings > Integrations](https://dash.userplane.io/_/settings?tab=integrations).

    <Frame caption="Zendesk integration settings">
      <img src="https://mintcdn.com/userplane/IKCB4f_KBaL0xsjW/media/zendesk/workspace-settings/post-connection-modal.png?fit=max&auto=format&n=IKCB4f_KBaL0xsjW&q=85&s=df3e16b30f9ebd74da4e20d8dcf3cd93" width="1920" height="958" data-path="media/zendesk/workspace-settings/post-connection-modal.png" />
    </Frame>
  </Step>

  <Step title="Click Disconnect">
    Click **Disconnect** next to Zendesk and confirm.
  </Step>
</Steps>

<Note>
  Disconnecting removes the Userplane app from Zendesk. Existing recordings and links are preserved.
</Note>

## Related articles

* [Help Desk Setup](/getting-started/helpdesk-setup) — setup guide for connecting your help desk.
* [Zendesk Ticket Sidebar](/integrations/zendesk-ticket-sidebar) — create links and view recordings from the ticket sidebar.
* [Zendesk Ticket Editor](/integrations/zendesk-ticket-editor) — insert recording links directly into replies.
* [Zendesk Top Bar](/integrations/zendesk-top-bar) — create links from anywhere in Zendesk.
* [Zendesk Notifications](/integrations/zendesk-notifications) — automatic internal notes when recordings arrive.