Zoom Cobrowse SDK
OpenAIOfficialCreated by ZoomDistributed by OpenAI
- Skill
- Tool integration
- Automation and integrations
- MIT
- No issues found
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
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/openai/zoom-cobrowse-sdk/downloadUnzip 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
Confirm the role model: customer page, agent console, session initiation, and how the PIN or link is handed off.
Check auth and session setup before UI work: tokens, allowed origins, environment variables, and SDK loading.
Design privacy controls early: masking rules, blocked elements, remote-assist permission boundaries, and audit requirements.
Implement the minimal lifecycle first: initialize, start or join, subscribe to events, reconnect, and end.
Add advanced capabilities only after the base session is stable: annotations, multi-tab persistence, custom PINs, and remote assist.
When debugging, isolate browser support, CORS/CSP, token generation, third-party cookie behavior, and SDK event errors.
References
Full preserved guide: references/full-guide.md
API reference: references/api-reference.md
Session lifecycle: concepts/session-lifecycle.md
Privacy masking: examples/privacy-masking.md
Remote assist: examples/remote-assist.md
Common issues: troubleshooting/common-issues.md
Files
- ATTRIBUTION.mdAdded by AutoGineer876 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.7 KiB
- SKILL.md1.5 KiB
- agents/openai.yaml134 B
- concepts/distribution-methods.md348 B
- concepts/jwt-authentication.md362 B
- concepts/session-lifecycle.md360 B
- concepts/two-roles-pattern.md1.4 KiB
- examples/agent-integration.md217 B
- examples/annotations.md224 B
- examples/auto-reconnection.md213 B
- examples/byop-custom-pin.md223 B
- examples/customer-integration.md222 B
- examples/multi-tab-persistence.md228 B
- examples/privacy-masking.md218 B
- examples/remote-assist.md231 B
- examples/session-events.md220 B
- get-started.md14.5 KiB
- references/api-official.md1.6 KiB
- references/api-reference.md117 B
- references/api.md74 B
- references/authorization-official.md2.0 KiB
- references/authorization.md104 B
- references/environment-variables.md778 B
- references/error-codes.md190 B
- references/features-official.md1.9 KiB
- references/features.md89 B
- references/full-guide.md31.8 KiB
- references/get-started-official.md1.9 KiB
- references/get-started.md98 B
- references/session-events.md150 B
- references/settings-reference.md193 B
- troubleshooting/browser-compatibility.md227 B
- troubleshooting/common-issues.md2.5 KiB
- troubleshooting/cors-csp.md283 B
- troubleshooting/error-codes.md216 B
troubleshooting/common-issues.md
Common Issues
Quick diagnostics for Zoom CoBrowse SDK issues.
Ensure SDK script/package is loaded.
Verify role-specific JWT generation on server.
Validate token expiry and clock skew.
Confirm session PIN flow between customer and agent.
Docs Links / 404s
Symptom: Official doc links you found are stale or return 404.
Fix:
Prefer the curated references under
references/(these are meant to stay stable even if external URLs drift).If you need working code, start from official sample repos referenced by the skill, then adapt to your stack.
Confusing "Who Creates the Session?"
Symptom: You built an "agent creates session" endpoint, but the customer flow seems to actually start the share / generate the PIN.
Fix:
Treat customer start/share as the action that creates the shareable context (PIN/session), then the agent joins using that PIN/session info.
Keep your server responsibilities narrow: token minting, optional auditing, and routing; avoid inventing "session creation" semantics that the SDK already owns.
Two PIN Values (Most Common Integration Mistake)
Symptom: UI shows one PIN from backend/session record and another PIN from SDK event, agent gets Pin not found or Cobrowse code not found.
Fix:
Treat
session.on("pincode_updated")as the authoritative support PIN for agent entry.Display exactly one primary PIN in UI (label it clearly as "Support PIN").
Do not surface provisional/debug PINs to users.
When opening agent page with
?pin=..., prefer freshly generated links and avoid stale bookmarks.
Agent Desk Error 30308 (Pincode is not found)
Symptom: Zoom-hosted agent desk shows:
Cobrowse code not founderror code
30308
Fix:
Ensure customer session is active and not expired before agent joins.
Use the latest PIN emitted by
pincode_updated.If your app restarts or uses in-memory state, persist session/PIN mapping or avoid strict local PIN gating for desk launch.
Have agent re-enter a fresh PIN from a newly started customer session.
Plain HTML / Express Integration Friction
Symptom: Quickstarts assume Vite/modern build pipeline; your plain HTML/Express adaptation breaks.
Fix:
Load the SDK exactly as the official snippet expects (script order matters).
Avoid bundler-only patterns in plain HTML (ESM imports,
import.meta, etc.) unless you add a bundler.
See:
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