AutoGineer
Generated banner for Build Zoom Virtual Agent
Generated logo for Build Zoom Virtual Agent

Build Zoom Virtual Agent

OpenAIOfficialCreated by ZoomDistributed by OpenAI

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

From the author

Use when using Virtual Agent.
— 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 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

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/openai/build-zoom-virtual-agent/download

  2. Unzip 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

  1. Identify the client: web, Android WebView, iOS WKWebView, campaign entry, support handoff, or knowledge-base sync pipeline.

  2. Route to the platform skill before coding because event handling and native bridge behavior differ by client.

  3. Confirm campaign, entry ID, allowed origins, lifecycle events, and support handoff behavior.

  4. Keep user context updates, native URL handling, and handoff payloads explicit.

  5. Debug by checking SDK readiness, campaign configuration, bridge injection, CSP, WebView lifecycle, and version drift.

References

Files

troubleshooting/common-drift-and-breaks.md

Common Drift and Breaks

SDK Not Ready

Symptoms:

  • window.zoomCampaignSdk is undefined.

Fix:

  • Register logic only after zoomCampaignSdk:ready.

  • Prefer waitForReady() when available.

Campaign Configured but Not Showing

Checks:

  • Confirm campaign targeting includes mobile when using Android/iOS WebView.

  • Validate style/config API network responses.

Subdomain/Login Failures

Symptoms:

  • Login fails due to subdomain connection issue.

Fix:

  • Verify subdomain allowlist and environment settings in Virtual Agent preferences.

Script Tag Loads Inconsistently

Cause:

  • defer can break execution order in certain third-party-link flows.

Fix:

  • Remove defer or use async based on page lifecycle.

Deprecated URL Command Usage

Symptoms:

  • Legacy openURL command path behaves unpredictably across versions.

Fix:

  • Use DOM links (target="_blank") or window.open and explicit native navigation handlers.

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