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://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

RUNBOOK.md

Cobrowse 5-Minute Preflight Runbook

Use this before deep debugging. It catches the most common Cobrowse failures quickly.

Skill Doc Standard Note

  • Agent-skill standard entrypoint is SKILL.md.

  • This runbook is an operational convention (recommended), not a required skill file.

  • SKILL.md is also a navigation convention for larger skill docs.

1) Confirm Two-Role Model

  • Customer role (role_type=1) starts session.

  • Agent role (role_type=2) joins session.

If your demo only has one generic role, expect broken join behavior.

2) Confirm PIN Source of Truth

  • Use customer SDK event pincode_updated as the only user-facing PIN.

  • Agent must join with that same PIN.

  • Do not show provisional/debug PIN values from backend records.

Common symptom if wrong: Pincode is not found / error 30308.

3) Confirm JWT Claims

  • Sign JWT on backend only.

  • Include required claim names exactly (for example user_id, not custom aliases).

  • Use SDK Key for SDK token context; keep SDK Secret server-side.

If claim names are wrong, token is rejected before session logic.

4) Confirm Session Order

Recommended sequence:

  1. Customer gets customer JWT and starts session.

  2. PIN is generated on customer side (pincode_updated).

  3. Agent gets agent JWT and joins with that PIN.

Starting agent flow before customer session is active often causes join failures.

5) Confirm Distribution Pattern

  • CDN path: customer SDK + Zoom-hosted agent desk iframe.

  • npm path: custom integration (BYOP mode required for custom PIN control).

If using npm agent integration without BYOP expectations, flow mismatches happen.

6) Confirm Browser and Security Constraints

  • HTTPS required (except loopback/local dev).

  • CSP/CORS must allow Zoom domains.

  • Third-party cookie/privacy settings can affect reconnect behavior.

Do not treat extension/adblock warnings as root cause until API/session checks fail.

7) Quick Checks (Backend + UI)

  • Backend config endpoint returns expected credential flags.

  • Customer page shows a single Support PIN from SDK event.

  • Agent page join uses same Support PIN and returns actionable response (not generic 404).

Copy/Paste Validation Commands
curl -sS -i "$COBROWSE_BASE_URL/customer"
curl -sS -i "$COBROWSE_BASE_URL/agent"
curl -sS -i "$COBROWSE_BASE_URL/api/config"

Expected: customer/agent pages load and config endpoint returns valid JSON flags.

8) Fast Decision Tree

  • Invalid token -> check JWT claim names and signing secret.

  • Agent cannot find PIN -> wrong PIN source or wrong session order.

  • Session drops on refresh -> check reconnection window and browser privacy/cookies.

  • Works locally, fails prod -> check HTTPS, CSP/CORS, reverse proxy pathing.

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