Build Zoom Virtual Agent
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 Zoom Virtual Agent in various environments, including web campaigns, Android WebView, and iOS WKWebView. It covers the end-to-end lifecycle from initial configuration in the Zoom admin portal to SDK initialization, bridge handler registration, and handling conversation events. The skill emphasizes platform-specific routing to ensure correct event handling and native integration behavior.
What it does
- Guides the configuration of campaigns and entry IDs within the Zoom Virtual Agent admin portal.
- Outlines the initialization process for web and mobile WebView SDKs.
- Provides patterns for registering native bridge handlers for exit, support handoff, and common events.
- Details the management of conversation lifecycle events and UI state.
- Offers a debugging checklist for SDK readiness, CSP, and WebView lifecycle issues.
- Facilitates knowledge-base synchronization using custom API connectors.
When to use it
- When embedding a Zoom Virtual Agent into a website or mobile application.
- When setting up native wrappers for web-based chat interfaces.
- When configuring support handoff flows between the bot and live agents.
- When troubleshooting integration issues related to WebView lifecycle or SDK readiness.
- When automating knowledge-base updates via custom API integrations.
Advantages
- Ensures consistent integration patterns across different client platforms.
- Reduces configuration errors by providing a clear lifecycle and readiness check sequence.
- Simplifies the implementation of complex features like native bridge handoffs.
- Provides a centralized reference for environment variables and API keys.
Usage examples
- “How do I initialize the Zoom Virtual Agent SDK in an Android WebView?”
- The agent will guide you through the Android-specific setup, including registering bridge handlers and ensuring the SDK is ready before executing commands.
- “What are the required environment variables for my web chat embed?”
- The agent will list the necessary variables such as ZVA_API_KEY, ZVA_ENV, and ZVA_CAMPAIGN_ID, and explain where to locate them in the Zoom admin portal.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/openai/build-zoom-virtual-agent/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip build-zoom-virtual-agent.zip -d .agents/skills
Documentation by Zoom
Build Zoom Virtual Agent
Use this skill when the workflow embeds or wraps Zoom Virtual Agent, including web campaigns and mobile WebView integrations.
Workflow
Identify the client: web, Android WebView, iOS WKWebView, campaign entry, support handoff, or knowledge-base sync pipeline.
Route to the platform skill before coding because event handling and native bridge behavior differ by client.
Confirm campaign, entry ID, allowed origins, lifecycle events, and support handoff behavior.
Keep user context updates, native URL handling, and handoff payloads explicit.
Debug by checking SDK readiness, campaign configuration, bridge injection, CSP, WebView lifecycle, and version drift.
References
Full preserved guide: references/full-guide.md
Web: web/SKILL.md
Android: android/SKILL.md
iOS: ios/SKILL.md
Architecture and lifecycle: concepts/architecture-and-lifecycle.md
Common drift and breaks: troubleshooting/common-drift-and-breaks.md
Files
- ATTRIBUTION.mdAdded by AutoGineer884 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md1.0 KiB
- SKILL.md1.2 KiB
- agents/openai.yaml146 B
- concepts/architecture-and-lifecycle.md949 B
- references/environment-variables.md844 B
- references/full-guide.md3.0 KiB
- references/samples-validation.md1.0 KiB
- references/versioning-and-drift.md823 B
- scenarios/high-level-scenarios.md961 B
- troubleshooting/common-drift-and-breaks.md942 B
references/full-guide.md
/build-zoom-virtual-agent
Background reference for Zoom Virtual Agent across:
Web campaign/chat embeds.
Android WebView wrappers.
iOS WKWebView wrappers.
Knowledge-base sync and custom API ingestion.
Official docs:
Routing Guardrail
If the user is implementing Contact Center app surfaces inside Zoom client, chain with ../contact-center/SKILL.md.
If the user needs backend knowledge-base CRUD or automation scripts, chain with ../rest-api/SKILL.md and ../oauth/SKILL.md.
If the user asks only for website bot embed and campaign controls, stay on web/SKILL.md.
If the user asks for mobile native wrappers around web chat, route to android/SKILL.md or ios/SKILL.md.
Quick Links
Platform skills:
Common Lifecycle Pattern
Configure campaign or entry ID in Virtual Agent admin.
Initialize SDK in web or WebView container.
Wait for readiness (
zoomCampaignSdk:readyorwaitForReady()) before calling APIs.Register bridge handlers (
exitHandler,commonHandler,support_handoff) when native orchestration is needed.Handle conversation lifecycle (
engagement_started,engagement_ended) and UI state.End chat (
endChat) and clean up listeners.
High-Level Scenarios
Website campaign launcher with contextual customer attributes.
Mobile app WebView chat with native close/handoff bridge.
External URL handling via system browser vs in-app browser policy.
Knowledge-base sync from external systems using custom API connector.
Cross-team support flow that escalates from bot to live support with handoff payload.
Chaining
Contact Center app/web/mobile patterns: ../contact-center/SKILL.md
OAuth app setup and tokens: ../oauth/SKILL.md
API workflows for KB automation: ../rest-api/SKILL.md
Event-driven backend follow-up: ../webhooks/SKILL.md
Operations
RUNBOOK.md - 5-minute preflight and debugging checklist.
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/virtual-agent · 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 build-zoom-virtual-agent.zip