Co-Browsing API

    Documentation

    How It Works

    Co-Browsing API allows one person (the Agent) to view the screen of another person (the Visitor) in real-time.

    Key Concepts

    Visitor

    The person whose screen is being shared. The Visitor has the SDK installed on their web page or app, and their screen is captured and streamed to the Agent.

    Agent

    The person viewing the Visitor's screen. Agents typically access the session through your dashboard or a custom integration using the REST API.

    Session

    A screen sharing session between one Visitor and one or more Agents. Sessions are temporary and end when either party disconnects.

    Integration Steps

    1. Install the SDK

    Add the SDK to the pages or app screens you want to be shareable. See the SDK documentation for platform-specific installation guides.

    2. Identify the Visitor

    To connect an Agent to a specific Visitor, you need a way to identify them. You have several options:

    MethodDescription
    Short IDGet the Upscope-generated ID via Upscope('getShortId') and pass it to your Agent-side code
    Unique IDUse your own identifier (e.g., user ID from your database) by passing it as uniqueId
    Integration IDUse an ID from another platform (e.g., Intercom, Zendesk) via integrationIds
    Lookup CodeHave the Visitor read a 4-digit code to the Agent over the phone

    If you are using anything other than the Short ID to identify the Visitor, first use the search endpoint to get their Short ID.

    3. Start a Session

    Once you have a Visitor identifier, create a session using the REST API:

    1. Call the start session endpoint with the Visitor's Short ID
    2. Receive a watch_url in the response
    3. Redirect the Agent's browser to this URL

    What's Next?