About build-zoom-virtual-agent
A reference skill for developers integrating Zoom Virtual Agent into websites and mobile WebView apps, or syncing knowledge bases. It covers web, Android, and iOS paths with guidance for routing work to related skills.
Key features
- 01Web, Android, and iOS integration guidance
- 02Chat initialization and lifecycle
- 03Native bridges and support handoff
- 04Knowledge-base sync and custom API ingestion
- 05Troubleshooting and runbook
Use cases
- 01Embed a website chat launcher with customer attributes
- 02Add chat to a mobile app WebView
- 03Hand off bot conversations to live support
- 04Sync a knowledge base from an external system
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/build-zoom-virtual-agentin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
RUNBOOK.mdandroid/concepts/webview-lifecycle.mdandroid/examples/js-bridge-patterns.mdandroid/references/android-reference-map.mdandroid/troubleshooting/common-issues.mdconcepts/architecture-and-lifecycle.mdios/concepts/webview-lifecycle.mdios/examples/js-bridge-patterns.mdios/references/ios-reference-map.mdios/troubleshooting/common-issues.mdreferences/environment-variables.mdsamples-validation.mdversioning-and-drift.mdscenarios/high-level-scenarios.mdtroubleshooting/common-drift-and-breaks.mdweb/concepts/lifecycle-and-events.mdweb/examples/campaign-and-entry-patterns.mdweb/references/web-reference-map.mdweb/troubleshooting/common-issues.mdDetails
From the project README/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:
- https://developers.zoom.us/docs/virtual-agent/
- https://developers.zoom.us/docs/virtual-agent/web/
- https://developers.zoom.us/docs/virtual-agent/android/
- https://developers.zoom.us/docs/virtual-agent/ios/
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
- concepts/architecture-and-lifecycle.md
- scenarios/high-level-scenarios.md
- references/versioning-and-drift.md
- references/samples-validation.md
- references/environment-variables.md
- troubleshooting/common-drift-and-breaks.md
- RUNBOOK.md
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.
Comments
Markdown supported