AutoGineer
Generated banner for Zoom Cobrowse SDK
Generated logo for Zoom Cobrowse SDK

Zoom Cobrowse SDK

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Automation and integrations
  • MIT
  • No issues found
Download ZIP

From the author

Use when using Cobrowse.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured approach to implementing the Zoom Cobrowse SDK. It covers the end-to-end lifecycle of a co-browsing session, including initialization, session management, event handling, and privacy configuration. It is designed to assist developers in setting up secure, browser-based co-browsing experiences between agents and customers.

What it does

  • Provides a workflow for initializing and managing co-browsing sessions.
  • Details configuration options for SDK keys, JWT tokens, and feature flags.
  • Outlines methods for starting, pausing, resuming, and ending sessions.
  • Explains how to implement privacy masking using CSS selectors.
  • Offers guidance on handling session events such as agent joins and departures.
  • Includes troubleshooting steps for common integration issues like CORS and token errors.

When to use it

  • When you need to integrate co-browsing capabilities into a web application.
  • When configuring privacy and masking rules for sensitive user data during sessions.
  • When debugging session connectivity, authentication, or event handling issues.
  • When implementing custom session PINs or remote assist features.

Advantages

  • Provides a clear, step-by-step implementation lifecycle.
  • Centralizes configuration and API usage patterns.
  • Includes specific guidance on security and privacy controls.
  • Offers a structured approach to troubleshooting common SDK errors.

Usage examples

“How do I initialize the Zoom Cobrowse SDK?”
The agent provides the initialization code snippet using the ZoomCobrowse constructor, including required configuration options like sdkKey and token.
“How can I mask sensitive elements during a co-browsing session?”
The agent explains how to use the masking.selectors configuration option to define CSS selectors that should be hidden from the agent.
“What events should I listen for to track session status?”
The agent lists the available event listeners such as sessionStarted, agentJoined, and sessionEnded to monitor the session lifecycle.
“How do I start a session programmatically?”
The agent demonstrates the use of the startSession method and explains how to handle the returned session object containing the PIN and session ID.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/openai/zoom-cobrowse-sdk/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip zoom-cobrowse-sdk.zip -d .agents/skills

Documentation by Zoom

Zoom Cobrowse SDK

Use this skill after the support workflow is clearly a browser co-browsing experience. If the user is still choosing between Zoom Contact Center, Virtual Agent, Video SDK, or Cobrowse, route through start or plan-zoom-product first.

Workflow

  1. Confirm the role model: customer page, agent console, session initiation, and how the PIN or link is handed off.

  2. Check auth and session setup before UI work: tokens, allowed origins, environment variables, and SDK loading.

  3. Design privacy controls early: masking rules, blocked elements, remote-assist permission boundaries, and audit requirements.

  4. Implement the minimal lifecycle first: initialize, start or join, subscribe to events, reconnect, and end.

  5. Add advanced capabilities only after the base session is stable: annotations, multi-tab persistence, custom PINs, and remote assist.

  6. When debugging, isolate browser support, CORS/CSP, token generation, third-party cookie behavior, and SDK event errors.

References

Files

references/get-started-official.md

Cobrowse SDK - Get Started

Set up collaborative browsing on your website.

Overview

This guide walks through integrating the Cobrowse SDK for customer-initiated sessions.

Prerequisites

  1. SDK Universal Credit on your Zoom account

  2. SDK Key and Secret

  3. Token server for JWT generation

Step 1: Get SDK Credentials

  1. In Zoom Workplace, go to Advanced → Zoom CPaaS → Manage

  2. Click Build App

  3. Locate SDK Key and SDK Secret

Step 2: Set Up Token Server

Generate JWTs server-side to protect your SDK Secret.

const jwt = require('jsonwebtoken');

function generateCobrowseToken(userId, userName, roleType) {
  const iat = Math.floor(Date.now() / 1000);
  const exp = iat + 3600; // 1 hour

  const payload = {
    user_id: userId,
    app_key: SDK_KEY,
    role_type: roleType,  // 1 = customer, 2 = agent
    user_name: userName,
    iat: iat,
    exp: exp
  };

  return jwt.sign(payload, SDK_SECRET, { algorithm: 'HS256' });
}

Step 3: Integrate Customer SDK

Add to your website:

<script src="https://cobrowse.zoom.us/sdk.js"></script>

<script>
async function startCobrowse() {
  // Get token from your server
  const token = await fetch('/api/cobrowse-token').then(r => r.json());

  const cobrowse = new ZoomCobrowse({
    sdkKey: 'YOUR_SDK_KEY',
    token: token.jwt
  });

  const session = await cobrowse.startSession();

  // Display PIN to customer
  alert(`Your session PIN: ${session.pin}`);
}
</script>

<button onclick="startCobrowse()">Start Support Session</button>

Step 4: Set Up Agent View

Agents join via iframe:

<iframe
  src="https://cobrowse.zoom.us/agent?pin={PIN}"
  allow="camera; microphone"
></iframe>

Next Steps

Resources

Requirements and compatibility

Written for: OpenAI Codex

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Zoom
Publisher
OpenAI (Official)
Distributed by
OpenAI
Source
openai/plugins · plugins/zoom/skills/cobrowse-sdk · commit d420d13
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from plugins/zoom/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or OpenAI.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download zoom-cobrowse-sdk.zip