Documentation

Build Your Own Request Button

Clients can request a co-browsing session with a button placed on your site. An alert is sent to the main app page, and the user requesting help will appear at the top of the page.

To activate this feature, navigate to General Settings » Request agent button. Here, you can decide when the button should appear (all the time, never, or when an agent is available), where it's placed on your website, and what the pop-up alert message says.

How to Build Your Own Button

If you'd like to create your own button and customize its appearance, follow these steps:

  1. Ensure your site has the code from app.upscope.io/install installed.
  2. To display the button only when agents are online, listen for agentsAvailable events.
  3. To request an agent, use Upscope('requestAgent');. You can cancel the request before it is accepted by calling Upscope('cancelRequestAgent');.
  4. To know the status of the request, listen to the agentRequestUpdate event.