Documentation Index

Fetch the complete documentation index at: https://docs.screenmeet.com/llms.txt

Use this file to discover all available pages before exploring further.

Getting end users into a CoBrowse Session

Prev Next

Getting Customers Into a CoBrowse Session

Overview

Once an agent starts a CoBrowse session, the customer needs a way to enter the session PIN and begin sharing their browser. This article covers three methods for getting customers into a session: Quick Links (best for live chat), clickable links that open the PIN modal automatically, and hotkeys that let customers trigger the modal themselves. Each method requires the ScreenMeet CoBrowse script to be installed on the destination page.


Quick Links are the fastest option when you are already in a live chat with the customer. After starting a CoBrowse session, the agent console displays a set of Quick Links directly below the session PIN. Each link is a pre-configured URL with the session PIN embedded as a hash parameter, for example:

https://www.example.com/support#cobrowse_pin=432017

The agent clicks the copy icon next to the desired URL and pastes it into the chat. When the customer opens the link, the CoBrowse script on the page reads the PIN from the URL and joins the session automatically, with no manual PIN entry required.

Configuring Quick Link URLs

Quick Link URLs are managed under Organization > Settings and Policies > CoBrowse Deployments. Only URLs pointing to pages with the CoBrowse script installed will work correctly. See CoBrowse Quick Links for setup instructions.


If you want customers to land on a CoBrowse-enabled page and be prompted to enter a PIN without needing the agent to send a session-specific link, append #startcb to any page URL that has the CoBrowse script installed. When the customer opens the link, the PIN entry modal opens automatically.

https://www.example.com/support#startcb

This approach is useful when you want to embed a persistent "Start CoBrowse Session" link in a support portal, email template, or chat widget. The customer clicks the link, the modal appears, and they enter the PIN the agent provides verbally or in chat.

Script Required on Destination Page

All URL-based methods only work on pages where the CoBrowse bootstrap script is present. If the customer lands on a page without the script, no modal will appear and the session will not start.


Method 3: Hotkeys

Hotkeys allow customers to open the CoBrowse PIN modal themselves using a keyboard shortcut, without clicking any link. This is useful when the CoBrowse script is already embedded site-wide and you want an always-available entry point that does not depend on the agent sending a URL.

Hotkeys are enabled by adding the following configuration block to your page, before the CoBrowse bootstrap script loads:

window.Cobrowse = window.Cobrowse || {};
window.Cobrowse.modal = window.Cobrowse.modal || {
  commandQueue: [],
  useHotkeys: true
};

With hotkeys enabled, the default key combinations are:

  • Shift + Space — opens the PIN entry modal

  • Shift + Escape — ends the current session

These bindings can be customized. The following example changes the start shortcut to Shift + Enter:

window.Cobrowse = window.Cobrowse || {};
window.Cobrowse.modal = window.Cobrowse.modal || {
  commandQueue: [],
  useHotkeys: true,
  hotkeys: {
    startSession: {
      shiftKey: true,
      keyCode: 13
    },
    endSession: {
      shiftKey: true,
      keyCode: 27
    }
  }
};

To disable hotkeys entirely, set useHotkeys to false.

Communicating the Shortcut to Customers

Hotkeys are not visible to the customer by default. If you use this method, instruct customers to press the shortcut via chat or a visible on-page prompt.


Comparison

Method

Best For

Customer Action Required

PIN Entry

Quick Links

Live chat sessions

Open the link

Automatic

Clickable link (#startcb)

Support portals, email templates

Open the link, enter PIN

Manual

Clickable link with PIN embedded

Agent-generated links sent mid-conversation

Open the link

Automatic

Hotkeys

Sites with always-on CoBrowse script

Press keyboard shortcut, enter PIN

Manual