Zoom General
AnthropicOfficialCreated by ZoomDistributed by Anthropic
- Skill
- Meta (authoring, orchestration, planning, memory)
- Agent tooling
- MIT
- Medium risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The zoom-general skill serves as the primary entry point and classification layer for developers working with the Zoom platform. It provides a structured framework to identify the correct Zoom product, SDK, or API path based on user intent. It includes logic for routing complex queries, chaining multiple skills (such as combining REST APIs with OAuth and webhooks), and resolving ambiguities between deterministic automation and AI-driven agentic workflows.
What it does
- Classifies developer queries to identify the appropriate Zoom product or SDK.
- Provides a routing matrix to distinguish between REST API, MCP, and SDK use cases.
- Offers guidance on choosing the correct Zoom app type (General, S2S, or Webhook-only).
- Facilitates skill chaining for multi-step integrations like OAuth and webhook setups.
- Provides decision frameworks for API vs. MCP and SDK vs. REST implementation paths.
- Acts as a central index for all specialized Zoom developer skills.
When to use it
- When you are unsure which Zoom SDK or API is required for your project.
- When you need to determine if your task requires REST APIs, MCP tools, or a hybrid approach.
- When planning a complex integration that involves authentication, webhooks, and API orchestration.
- When you need to compare different Zoom app types to match your architectural requirements.
- When you need to resolve ambiguity between similar Zoom products like Meeting SDK and Video SDK.
Advantages
- Reduces development friction by directing users to the most relevant documentation and skills.
- Ensures architectural consistency by enforcing standard routing patterns.
- Simplifies complex decision-making through clear matrices and guardrails.
- Promotes best practices for authentication and event-driven design.
- Provides a unified entry point for navigating the entire Zoom developer ecosystem.
Usage examples
- “I want to build a custom video UI for a Zoom meeting on the web, what should I use?”
- The skill identifies the requirement for a custom UI around a real meeting and routes the user to the zoom-meeting-sdk-web-component-view skill.
- “Should I use the REST API or MCP for my AI agent?”
- The skill provides the API vs. MCP routing matrix, explaining that REST is for deterministic automation while MCP is for dynamic AI tool orchestration.
- “How do I set up a server-side integration that handles meetings and webhooks?”
- The skill suggests the Rivet SDK for scaffolding or chains the zoom-rest-api, zoom-oauth, and zoom-webhooks skills.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/anthropics/zoom-general/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip zoom-general.zip -d .agents/skills
Documentation by Zoom
Zoom General (Cross-Product Skills)
Background reference for cross-product Zoom questions. Prefer the workflow skills first, then use this file for shared platform guidance and routing detail.
How zoom-general Routes a Complex Developer Query
Use zoom-general as the classifier and chaining layer:
detect product signals in the query
pick one primary skill
attach secondary skills for auth, events, or deployment edges
ask one short clarifier only when two routes match with similar confidence
Minimal implementation:
type SkillId =
| 'zoom-general'
| 'zoom-rest-api'
| 'zoom-webhooks'
| 'zoom-oauth'
| 'zoom-meeting-sdk-web-component-view'
| 'zoom-video-sdk'
| 'zoom-mcp';
const hasAny = (q: string, words: string[]) => words.some((w) => q.includes(w));
function detectSignals(rawQuery: string) {
const q = rawQuery.toLowerCase();
return {
meetingCustomUi: hasAny(q, ['zoom meeting', 'custom ui', 'component view', 'embed meeting']),
customVideo: hasAny(q, ['video sdk', 'custom video session', 'peer-video-state-change']),
restApi: hasAny(q, ['rest api', '/v2/', 'create meeting', 'list users', 's2s oauth']),
webhooks: hasAny(q, ['webhook', 'x-zm-signature', 'event subscription', 'crc']),
oauth: hasAny(q, ['oauth', 'pkce', 'token refresh', 'account_credentials']),
mcp: hasAny(q, ['zoom mcp', 'agentic retrieval', 'tools/list', 'semantic meeting search']),
};
}
function pickPrimarySkill(s: ReturnType<typeof detectSignals>): SkillId {
if (s.meetingCustomUi) return 'zoom-meeting-sdk-web-component-view';
if (s.mcp) return 'zoom-mcp';
if (s.restApi) return 'zoom-rest-api';
if (s.customVideo) return 'zoom-video-sdk';
return 'zoom-general';
}
function buildChain(primary: SkillId, s: ReturnType<typeof detectSignals>): SkillId[] {
const chain = [primary];
if (s.oauth && !chain.includes('zoom-oauth')) chain.push('zoom-oauth');
if (s.webhooks && !chain.includes('zoom-webhooks')) chain.push('zoom-webhooks');
return chain;
}Example:
Create a meeting, configure webhooks, and handle OAuth token refresh->zoom-rest-api -> zoom-oauth -> zoom-webhooksBuild a custom video UI for a Zoom meeting on web->zoom-meeting-sdk-web-component-view
For the full TypeScript implementation and handoff contract, use references/routing-implementation.md.
Choose Your Path
| I want to... | Use this skill |
|---|---|
| Build a custom web UI around a real Zoom meeting | zoom-meeting-sdk-web-component-view |
| Build deterministic automation/configuration/reporting with explicit request control | zoom-rest-api |
| Receive event notifications (HTTP push) | zoom-webhooks |
| Receive event notifications (WebSocket, low-latency) | zoom-websockets |
| Embed Zoom meetings in my app | zoom-meeting-sdk |
| Build custom video experiences (Web, React Native, Flutter, Android, iOS, macOS, Unity, Linux) | zoom-video-sdk |
| Build an app that runs inside Zoom client | zoom-apps-sdk |
| Transcribe uploaded or stored media with AI Services Scribe | scribe |
| Access live audio/video/transcripts from meetings | zoom-rtms |
| Enable collaborative browsing for support | zoom-cobrowse-sdk |
| Build Contact Center apps and channel integrations | contact-center |
| Build Virtual Agent web/mobile chatbot experiences | virtual-agent |
| Build Zoom Phone integrations (Smart Embed, Phone API, webhooks, URI flows) | phone |
| Build Team Chat apps and integrations | zoom-team-chat |
| Build server-side integrations with Rivet (auth + webhooks + APIs) | rivet-sdk |
| Run browser/device/network preflight diagnostics before join | probe-sdk |
| Add pre-built UI components for Video SDK | zoom-ui-toolkit |
| Implement OAuth authentication (all grant types) | zoom-oauth |
| Build AI-driven tool workflows (AI Companion/agents) over Zoom data | zoom-mcp |
| Build AI-driven Whiteboard workflows over Zoom Whiteboard MCP | zoom-mcp/whiteboard |
| Build enterprise AI systems with stable API core + AI tool layer | zoom-rest-api + zoom-mcp |
Planning Checkpoint: Rivet SDK (Optional)
When a user starts planning a server-side integration that combines auth + webhooks + API calls, ask this first:
Rivet SDK is a Node.js framework that bundles Zoom auth handling, webhook receivers, and typed API wrappers.Do you want to use Rivet SDK for faster scaffolding, or do you prefer a direct OAuth + REST implementation without Rivet?
Routing after answer:
If user chooses Rivet: chain
rivet-sdk+oauth+rest-api.If user declines Rivet: chain
oauth+rest-api(+webhooksor product skill as needed).
SDK vs REST Routing Matrix (Hard Stop)
| User intent | Correct path | Do not route to |
|---|---|---|
| Embed Zoom meeting in app UI | zoom-meeting-sdk | REST-only join_url flow |
| Build custom web UI for a real Zoom meeting | zoom-meeting-sdk-web-component-view | zoom-video-sdk |
| Build custom video UI/session app | zoom-video-sdk | Meeting SDK or REST meeting links |
| Get browser join links / manage meeting resources | zoom-rest-api | Meeting SDK join implementation |
Routing guardrails:
If user asks for SDK embed/join behavior, stay in SDK path.
If the prompt says meeting plus custom UI/video/layout/embed, prefer
zoom-meeting-sdk-web-component-view.Only use
zoom-video-sdkwhen the user is building a custom session product rather than a Zoom meeting.Only use REST path for resource management, reporting, or link distribution unless user explicitly requests a mixed architecture.
For executable classification/chaining logic and error handling, see references/routing-implementation.md.
API vs MCP Routing Matrix (Hard Stop)
| User intent | Correct path | Why |
|---|---|---|
| Deterministic backend automation, account/user configuration, reporting, scheduled jobs | zoom-rest-api | Explicit request/response control and repeatable behavior |
| AI agent chooses tools dynamically, cross-platform AI tool interoperability | zoom-mcp | MCP is optimized for dynamic tool discovery and agentic workflows |
| Enterprise AI architecture (stable core + adaptive AI layer) | zoom-rest-api + zoom-mcp | APIs run core system actions; MCP exposes curated AI tools/context |
Routing guardrails:
Do not replace deterministic backend APIs with MCP-only routing.
Do not force raw REST-first routing when the task is AI-agent tool orchestration.
Prefer hybrid routing when the user needs both stable automation and AI-driven interactions.
MCP remote server works over Streamable HTTP/SSE; use this path when the target client/agent supports MCP transports (for example Claude or VS Code).
Do not design per-tenant custom MCP endpoint provisioning; Zoom MCP endpoints are shared at instance/cluster level.
Source: https://developers.zoom.us/docs/mcp/library/resources/apis-vs-mcp/
Ambiguity Resolution (Ask Before Routing)
When a prompt matches both API and MCP paths with similar confidence, ask one short clarifier before execution:
Do you want deterministic REST API automation, AI-agent MCP tooling, or a hybrid of both?
Then route as:
REST answer →
zoom-rest-apiMCP answer →
zoom-mcpHybrid answer →
zoom-rest-api + zoom-mcp
MCP Availability and Topology Notes
Zoom-hosted MCP access is evolving; docs indicate a model where Zoom exposes product-scoped MCP servers (for example Meetings, Team Chat, Whiteboard).
Use
zoom-mcpas the parent MCP entry point.Route Whiteboard-specific MCP requests to zoom-mcp/whiteboard.
When a request is product-specific and MCP coverage exists, route to that MCP product surface first; otherwise use REST/SDK skills for deterministic implementation.
Webhooks vs WebSockets
Both receive event notifications, but differ in approach:
| Aspect | webhooks | zoom-websockets |
|---|---|---|
| Connection | HTTP POST to your endpoint | Persistent WebSocket |
| Latency | Higher | Lower |
| Security | Requires public endpoint | No exposed endpoint |
| Setup | Simpler | More complex |
| Best for | Most use cases | Real-time, security-sensitive |
Common Use Cases
| Use Case | Description | Skills Needed |
|---|---|---|
| Meeting + Webhooks + OAuth Refresh | Create a meeting, process real-time updates, and refresh OAuth tokens safely in one design | zoom-rest-api + zoom-oauth + zoom-webhooks |
| Scribe Transcription Pipeline | Transcribe uploaded files or S3 archives with AI Services Scribe using fast mode or batch jobs | scribe + optional zoom-rest-api + optional zoom-webhooks |
| APIs vs MCP Routing | Decide whether to route to deterministic Zoom APIs, AI-driven MCP, or a hybrid design | zoom-rest-api and/or zoom-mcp |
| Custom Meeting UI (Web) | Build a custom video UI for a real Zoom meeting in a web app using Meeting SDK Component View | zoom-meeting-sdk-web-component-view + zoom-oauth |
| Meeting Automation | Schedule, update, delete meetings programmatically | zoom-rest-api |
| Meeting Bots | Build bots that join meetings for AI/transcription/recording | meeting-sdk/linux + zoom-rest-api + optional zoom-webhooks |
| High-Volume Meeting Platform | Design distributed meeting creation and event processing with retries, queues, and reconciliation | zoom-rest-api + zoom-webhooks + zoom-oauth |
| Recording & Transcription | Download recordings, get transcripts | zoom-webhooks + zoom-rest-api |
| Recording Download Pipeline | Auto-download recordings to your own storage (S3, GCS, etc.) | zoom-webhooks + zoom-rest-api |
| Real-Time Media Streams | Access live audio, video, transcripts via WebSocket | zoom-rtms + zoom-webhooks |
| In-Meeting Apps | Build apps that run inside Zoom meetings | zoom-apps-sdk + zoom-oauth |
| React Native Meeting Embed | Embed meetings into iOS/Android React Native apps | zoom-meeting-sdk-react-native + zoom-oauth |
| Native Meeting SDK Multi-Platform Delivery | Align Android, iOS, macOS, and Unreal Meeting SDK implementations under one auth/version strategy | zoom-meeting-sdk + platform skills |
| Native Video SDK Multi-Platform Delivery | Align Android, iOS, macOS, and Unity Video SDK implementations under one auth/version strategy | zoom-video-sdk + platform skills |
| Electron Meeting Embed | Embed meetings into desktop Electron apps | zoom-meeting-sdk-electron + zoom-oauth |
| Flutter Video Sessions | Build custom mobile video sessions in Flutter | zoom-video-sdk-flutter + zoom-oauth |
| React Native Video Sessions | Build custom mobile video sessions in React Native | zoom-video-sdk-react-native + zoom-oauth |
| Immersive Experiences | Custom video layouts with Layers API | zoom-apps-sdk |
| Collaborative Apps | Real-time shared state in meetings | zoom-apps-sdk |
| Contact Center App Lifecycle and Context Switching | Build Contact Center apps that handle engagement events and multi-engagement state | contact-center + zoom-apps-sdk |
| Virtual Agent Campaign Web and Mobile Wrapper | Deliver one campaign-driven bot flow across web and native mobile wrappers | virtual-agent + contact-center |
| Virtual Agent Knowledge Base Sync Pipeline | Sync external knowledge content into Zoom Virtual Agent using web sync or custom API connectors | virtual-agent + zoom-rest-api + zoom-oauth |
| Zoom Phone Smart Embed CRM Integration | Build CRM dialer and call logging flows using Smart Embed plus Phone APIs | phone + zoom-oauth + zoom-webhooks |
| Rivet Event-Driven API Orchestrator | Build a Node.js backend that combines webhooks and API actions through Rivet module clients | rivet-sdk + zoom-oauth + zoom-rest-api |
| Probe SDK Preflight Readiness Gate | Add browser/device/network diagnostics and readiness policy before Meeting SDK or Video SDK joins | probe-sdk + zoom-meeting-sdk or zoom-video-sdk |
Complete Use-Case Index
APIs vs MCP Routing: choose API-only, MCP-only, or hybrid routing using official Zoom criteria.
AI Companion Integration: connect Zoom AI Companion capabilities into your app workflow.
AI Integration: add summarization, transcription, or assistant logic using Zoom data surfaces.
Backend Automation (S2S OAuth): run server-side jobs with account-level OAuth credentials.
Collaborative Apps: build shared in-meeting app state and interactions.
Contact Center Integration: connect Zoom Contact Center signals into external systems.
Contact Center App Lifecycle and Context Switching: implement event-driven engagement state and safe context switching in Contact Center apps.
Virtual Agent Campaign Web and Mobile Wrapper: deploy campaign-based Virtual Agent chat across website and Android/iOS WebView wrappers.
Virtual Agent Knowledge Base Sync Pipeline: automate knowledge-base ingestion with web sync strategy or custom API connector.
Zoom Phone Smart Embed CRM Integration: integrate Smart Embed events, Phone APIs, and CRM workflows with migration-safe data handling.
Rivet Event-Driven API Orchestrator: build a Node.js backend that combines webhook handling and API orchestration with Rivet.
Probe SDK Preflight Readiness Gate: run browser/device/network diagnostics before launching meeting or video session workflows.
Custom Video: decide between Video SDK and related components for custom session UX.
Custom Meeting UI (Web): use Meeting SDK Component View for a custom UI around a real Zoom meeting.
Scribe Transcription Pipeline: use AI Services Scribe for on-demand file transcription and batch archive processing.
Video SDK Bring Your Own Storage: configure Video SDK cloud recordings to write directly to your own S3 bucket.
Customer Support Cobrowsing: implement customer-agent collaborative browsing support flows.
Embed Meetings: embed Zoom meeting experience into your app.
Form Completion Assistant: build guided flows for form filling and completion assistance.
HD Video Resolution: enable and troubleshoot high-definition video requirements.
High-Volume Meeting Platform: build distributed meeting creation and event processing with concrete fallback patterns.
Immersive Experiences: use Zoom Apps Layers APIs for custom in-meeting visuals.
In-Meeting Apps: build Zoom Apps that run directly inside meeting and webinar contexts.
Marketplace Publishing: prepare and ship a Zoom app through Marketplace review.
Meeting Automation: create, update, and manage meetings programmatically.
Meeting Bots: build bots for meeting join, capture, and real-time analysis.
Native Meeting SDK Multi-Platform Delivery: standardize Android, iOS, macOS, and Unreal Meeting SDK delivery with shared auth and version controls.
Native Video SDK Multi-Platform Delivery: standardize Android, iOS, macOS, and Unity Video SDK delivery with shared auth and version controls.
Meeting Details with Events: combine REST retrieval with webhook event streams.
Minutes Calculation: compute usage and minute metrics across meetings/sessions.
Prebuilt Video UI: use UI Toolkit for faster Video SDK-based UI delivery.
QSS Monitoring: monitor Zoom quality statistics and performance indicators.
Raw Recording: capture raw streams for custom recording and processing pipelines.
Electron Meeting Embed: embed meetings in an Electron desktop application.
Flutter Video Sessions: build Video SDK sessions in Flutter mobile apps.
React Native Meeting Embed: embed Meeting SDK into React Native apps.
React Native Video Sessions: build custom video sessions in React Native.
Real-Time Media Streams: consume live media/transcript streams via RTMS.
Recording Download Pipeline: automate recording retrieval and storage pipelines.
Recording & Transcription: manage post-meeting recordings and transcript workflows.
Retrieve Meeting and Subscribe Events: join REST meeting fetch with event subscriptions.
SaaS App OAuth Integration: implement user-level OAuth in multi-tenant SaaS apps.
SDK Size Optimization: reduce bundle/runtime footprint for SDK-based apps.
SDK Wrappers and GUI: evaluate wrapper patterns and GUI frameworks around SDKs.
Team Chat LLM Bot: build a Team Chat bot with LLM-powered responses.
Testing and Development: local testing patterns, mocks, and safe development loops.
Token and Scope Troubleshooting: debug OAuth scope and token mismatch issues.
Transcription Bot (Linux): run Linux meeting bots for live transcription workloads.
Usage Reporting and Analytics: collect and analyze usage/reporting data.
User and Meeting Creation: provision users and schedule meetings in one flow.
Web SDK Embedding: embed meeting experiences in browser-based web apps.
Server-to-Server OAuth with Webhooks: combine account OAuth with event-driven backend processing.
Meeting Links vs Embedding: choose between
join_urldistribution and SDK embedding.Enterprise App Deployment: deploy, govern, and operate Zoom integrations at enterprise scale.
Prerequisites
Zoom account (Pro, Business, or Enterprise)
App created in Zoom App Marketplace
OAuth credentials (Client ID and Secret)
References
Quick Start
Go to marketplace.zoom.us
Click Develop → Build App
Select app type (see references/app-types.md)
Configure OAuth and scopes
Copy credentials to your application
Detailed References
references/authentication.md - OAuth 2.0, S2S OAuth, JWT patterns
references/app-types.md - Decision guide for app types
references/scopes.md - OAuth scopes reference
references/marketplace.md - Marketplace portal navigation
references/query-routing-playbook.md - Route complex queries to the right specialized skills
references/interview-answer-routing.md - Short interview-ready answer pattern for zoom-general routing
references/routing-implementation.md - Concrete TypeScript query classification and skill handoff contract
references/automatic-skill-chaining-rest-webhooks.md - Executable process for REST + webhook chained workflows
references/meeting-webhooks-oauth-refresh-orchestration.md - Concrete design for meeting creation + webhook updates + OAuth token refresh
references/distributed-meeting-fallback-architecture.md - High-volume distributed architecture with retries, circuit breakers, and reconciliation fallbacks
references/community-repos.md - Curated official Zoom sample repositories by product
SDK Maintenance
references/sdk-upgrade-guide.md - Version policy, upgrade steps
references/sdk-upgrade-workflow.md - Changelog + RSS, version-by-version reusable upgrade workflow
references/sdk-logs-troubleshooting.md - Collecting SDK logs
Resources
Official docs: https://developers.zoom.us/
Marketplace: https://marketplace.zoom.us/
Developer forum: https://devforum.zoom.us/
Environment Variables
See references/environment-variables.md for standardized
.envkeys and where to find each value.
Operations
RUNBOOK.md - 5-minute preflight and debugging checklist.
Files
- ATTRIBUTION.mdAdded by AutoGineer975 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.4 KiB
- SKILL.md25.3 KiB
- references/app-types.md2.6 KiB
- references/authentication.md2.0 KiB
- references/authorization-patterns.md21.3 KiB
- references/automatic-skill-chaining-rest-webhooks.md5.5 KiB
- references/community-repos.md9.3 KiB
- references/distributed-meeting-fallback-architecture.md14.0 KiB
- references/environment-variables.md3.0 KiB
- references/interview-answer-routing.md797 B
- references/known-limitations.md2.5 KiB
- references/marketplace.md1.6 KiB
- references/meeting-webhooks-oauth-refresh-orchestration.md5.3 KiB
- references/query-routing-playbook.md2.7 KiB
- references/routing-implementation.md8.7 KiB
- references/scopes.md3.4 KiB
- references/sdk-logs-troubleshooting.md5.7 KiB
- references/sdk-upgrade-guide.md4.1 KiB
- references/sdk-upgrade-workflow.md3.5 KiB
- use-cases/ai-companion-integration.md10.0 KiB
- use-cases/ai-integration.md7.2 KiB
- use-cases/apis-vs-mcp-routing.md3.5 KiB
- use-cases/backend-automation-s2s-oauth.md5.0 KiB
- use-cases/collaborative-apps.md2.6 KiB
- use-cases/contact-center-app-lifecycle-and-context-switching.md1.2 KiB
- use-cases/contact-center-integration.md1.1 KiB
- use-cases/custom-meeting-ui-web.md2.8 KiB
- use-cases/custom-video.md5.6 KiB
- use-cases/customer-support-cobrowsing.md12.6 KiB
- use-cases/electron-meeting-embed.md1020 B
- use-cases/embed-meetings.md4.9 KiB
- use-cases/enterprise-app-deployment.md1.0 KiB
- use-cases/flutter-video-sessions.md910 B
- use-cases/form-completion-assistant.md15.4 KiB
- use-cases/hd-video-resolution.md8.8 KiB
- use-cases/high-volume-meeting-platform.md1.9 KiB
- use-cases/immersive-experiences.md2.9 KiB
- use-cases/in-meeting-apps.md7.5 KiB
- use-cases/marketplace-publishing.md9.2 KiB
- use-cases/meeting-automation.md6.3 KiB
- use-cases/meeting-bots.md10.6 KiB
- use-cases/meeting-details-with-events.md20.9 KiB
- use-cases/meeting-links-vs-embedding.md989 B
- use-cases/minutes-calculation.md22.6 KiB
- use-cases/native-meeting-sdk-multi-platform.md1.5 KiB
- use-cases/native-video-sdk-multi-platform.md1.2 KiB
- use-cases/prebuilt-video-ui.md12.4 KiB
- use-cases/probe-sdk-preflight-readiness-gate.md1.2 KiB
- use-cases/qss-monitoring.md2.7 KiB
- use-cases/raw-recording.md5.1 KiB
- use-cases/react-native-meeting-embed.md1.0 KiB
- use-cases/react-native-video-sessions.md953 B
- use-cases/real-time-media-streams.md5.5 KiB
- use-cases/recording-download-pipeline.md8.8 KiB
- use-cases/recording-transcription.md7.6 KiB
- use-cases/retrieve-meeting-and-subscribe-events.md33.1 KiB
- use-cases/rivet-event-driven-api-orchestrator.md1.3 KiB
- use-cases/saas-app-oauth-integration.md4.8 KiB
- use-cases/scribe-transcription-pipeline.md1.8 KiB
- use-cases/sdk-size-optimization.md5.0 KiB
- use-cases/sdk-wrappers-gui.md18.6 KiB
- use-cases/server-to-server-oauth-with-webhooks.md1.7 KiB
- use-cases/team-chat-llm-bot.md6.9 KiB
- use-cases/testing-development.md7.2 KiB
- use-cases/token-and-scope-troubleshooting.md2.4 KiB
- use-cases/transcription-bot-linux.md14.5 KiB
- use-cases/usage-reporting-analytics.md8.6 KiB
- use-cases/user-and-meeting-creation.md17.0 KiB
- use-cases/video-sdk-bring-your-own-storage.md6.9 KiB
- use-cases/virtual-agent-campaign-web-mobile-wrapper.md1.4 KiB
- use-cases/virtual-agent-knowledge-base-sync-pipeline.md1.1 KiB
- use-cases/web-sdk-embedding.md4.5 KiB
- use-cases/zoom-phone-smart-embed-crm.md876 B
use-cases/retrieve-meeting-and-subscribe-events.md
Retrieve Meeting Details and Subscribe to Events
Comprehensive guide showing all ways to retrieve meeting details and subscribe to events in Zoom. The term "subscribe to events" has multiple meanings in Zoom, each requiring different skill combinations.
Overview
When someone says "retrieve meeting details and subscribe to events," they could mean:
| Pattern | Event Type | Skills | When to Use |
|---|---|---|---|
| Pattern 1 | Server-side webhooks (HTTP) | zoom-rest-api → webhooks | Account-level event monitoring, backend processing |
| Pattern 2 | Server-side WebSockets (WS) | zoom-rest-api → zoom-websockets | Low-latency events, no exposed endpoint |
| Pattern 3 | Client-side SDK events | zoom-rest-api → zoom-meeting-sdk | In-meeting participant events, real-time UI updates |
| Pattern 4 | Real-time media events | zoom-rest-api → rtms | Bot-based transcription, recording, AI analysis |
| Pattern 5 | Reports API (polling) | zoom-rest-api only | Historical data, batch processing |
Critical Distinction: Event Subscription Scope
Important: Most Zoom event subscriptions are account-level, not meeting-specific:
| Subscription Type | Scope | Filtering |
|---|---|---|
| Webhooks | Account-level | Filter events by meeting ID in handler |
| WebSockets | Account-level | Filter events by meeting ID in handler |
| Meeting SDK | Meeting-specific | Only events for joined meeting |
| RTMS | Meeting-specific | Only events/media for specific meeting |
| Reports API | Account-level | Query by meeting ID |
You cannot dynamically subscribe to webhooks/WebSockets for a single meeting. These are configured at app creation time in the Marketplace portal and receive events for ALL meetings in the account. Your code filters events by meeting ID.
Pattern 1: REST API + Webhooks (Server-Side HTTP Events)
When to use:
Backend processing of meeting lifecycle events
Attendance tracking, post-meeting workflows
Recording download automation
Standard event-driven architectures
Skills needed: zoom-rest-api → webhooks
Flow Diagram
┌────────────────────────────────────────────────────────────────┐
│ SETUP PHASE (One-time in Marketplace Portal): │
│ │
│ 1. Configure Event Subscriptions │
│ └── Subscribe to: meeting.started, meeting.ended, etc. │
│ └── Provide webhook endpoint URL │
│ └── Get webhook secret token │
└────────────────────────────────────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────────┐
│ RUNTIME PHASE: │
│ │
│ Step 1: GET /meetings/{meetingId} (zoom-rest-api) │
│ └── Get meeting details (topic, join_url, host, etc.) │
│ │
│ Step 2: Store meeting ID for filtering │
│ └── Your backend remembers which meetings to track │
│ │
│ Step 3: POST /webhooks/zoom (webhooks) │
│ └── Zoom sends events for ALL meetings │
│ └── Filter by meeting ID in your handler │
│ └── Process: started, ended, participant events │
└────────────────────────────────────────────────────────────────┘Complete Implementation
const express = require('express');
const axios = require('axios');
const crypto = require('crypto');
const app = express();
app.use(express.json());
// Track which meetings we care about (use Redis/DB in production)
const trackedMeetings = new Set();
// ============================================
// STEP 1: Retrieve Meeting Details (zoom-rest-api)
// ============================================
async function getAccessToken() {
const credentials = Buffer.from(
`${process.env.ZOOM_CLIENT_ID}:${process.env.ZOOM_CLIENT_SECRET}`
).toString('base64');
const response = await axios.post(
`https://zoom.us/oauth/token?grant_type=account_credentials&account_id=${process.env.ZOOM_ACCOUNT_ID}`,
null,
{ headers: { 'Authorization': `Basic ${credentials}` } }
);
return response.data.access_token;
}
async function getMeetingDetails(meetingId) {
const token = await getAccessToken();
const response = await axios.get(
`https://api.zoom.us/v2/meetings/${meetingId}`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return response.data;
}
// API: Fetch meeting and start tracking it
app.get('/api/meetings/:meetingId', async (req, res) => {
try {
const { meetingId } = req.params;
// Get meeting details
const meeting = await getMeetingDetails(meetingId);
// Add to tracked set (events for this meeting will be processed)
trackedMeetings.add(String(meeting.id));
console.log(`✅ Now tracking meeting: ${meeting.topic} (${meeting.id})`);
res.json({
success: true,
meeting: {
id: meeting.id,
topic: meeting.topic,
start_time: meeting.start_time,
join_url: meeting.join_url
},
message: 'Meeting tracked. Webhook events will be processed for this meeting.'
});
} catch (error) {
res.status(error.response?.status || 500).json({
success: false,
error: error.message
});
}
});
// ============================================
// STEP 2: Handle Webhook Events (webhooks)
// ============================================
function verifyWebhookSignature(req) {
const signature = req.headers['x-zm-signature'];
const timestamp = req.headers['x-zm-request-timestamp'];
const payload = `v0:${timestamp}:${JSON.stringify(req.body)}`;
const expectedSignature = `v0=${crypto
.createHmac('sha256', process.env.ZOOM_WEBHOOK_SECRET)
.update(payload)
.digest('hex')}`;
return signature === expectedSignature;
}
app.post('/webhooks/zoom', async (req, res) => {
// Handle URL validation challenge
if (req.body.event === 'endpoint.url_validation') {
const hash = crypto
.createHmac('sha256', process.env.ZOOM_WEBHOOK_SECRET)
.update(req.body.payload.plainToken)
.digest('hex');
return res.json({
plainToken: req.body.payload.plainToken,
encryptedToken: hash
});
}
// Verify signature
if (!verifyWebhookSignature(req)) {
console.error('❌ Invalid webhook signature');
return res.status(401).send('Invalid signature');
}
const { event, payload } = req.body;
const meetingId = String(payload.object.id);
// CRITICAL: Filter events - only process tracked meetings
if (!trackedMeetings.has(meetingId)) {
console.log(`⏭️ Ignoring event for untracked meeting ${meetingId}`);
return res.status(200).send();
}
// Process events for tracked meetings
console.log(`📩 Event: ${event} for meeting ${meetingId}`);
switch (event) {
case 'meeting.started':
console.log(`✅ Meeting started: ${payload.object.topic}`);
// Handle meeting start
break;
case 'meeting.ended':
console.log(`🏁 Meeting ended: ${payload.object.topic}`);
// Handle meeting end, cleanup
trackedMeetings.delete(meetingId);
break;
case 'meeting.participant_joined':
console.log(`👋 ${payload.object.participant.user_name} joined`);
// Track attendance
break;
case 'meeting.participant_left':
console.log(`👋 ${payload.object.participant.user_name} left`);
// Update attendance
break;
}
res.status(200).send();
});
app.listen(3000, () => {
console.log('Server running on port 3000');
console.log('');
console.log('Endpoints:');
console.log(' GET /api/meetings/:id - Fetch & track meeting');
console.log(' POST /webhooks/zoom - Webhook receiver');
});See also: meeting-details-with-events.md for expanded webhook implementation.
Pattern 2: REST API + WebSockets (Server-Side Low-Latency Events)
When to use:
Lower latency than webhooks required
Security-sensitive industries (no exposed endpoint)
Bidirectional communication needed
Real-time dashboards, live monitoring
Skills needed: zoom-rest-api → zoom-websockets
Flow Diagram
┌────────────────────────────────────────────────────────────────┐
│ SETUP PHASE (One-time in Marketplace Portal): │
│ │
│ 1. Create Server-to-Server OAuth app │
│ 2. Configure WebSocket Event Subscription │
│ └── Subscribe to: meeting.started, meeting.ended, etc. │
│ └── Get subscription ID │
└────────────────────────────────────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────────┐
│ RUNTIME PHASE: │
│ │
│ Step 1: GET /meetings/{meetingId} (zoom-rest-api) │
│ └── Get meeting details │
│ │
│ Step 2: Connect to WebSocket (zoom-websockets) │
│ └── wss://ws.zoom.us/ws?subscriptionId=... │
│ └── Authenticate with S2S OAuth access token │
│ │
│ Step 3: Receive events via WebSocket │
│ └── Filter by meeting ID in message handler │
│ └── Lower latency than webhooks │
└────────────────────────────────────────────────────────────────┘Complete Implementation
const axios = require('axios');
const WebSocket = require('ws');
// Track which meetings we care about
const trackedMeetings = new Set();
let ws = null;
// ============================================
// STEP 1: Retrieve Meeting Details (zoom-rest-api)
// ============================================
async function getAccessToken() {
const credentials = Buffer.from(
`${process.env.ZOOM_CLIENT_ID}:${process.env.ZOOM_CLIENT_SECRET}`
).toString('base64');
const response = await axios.post(
'https://zoom.us/oauth/token',
new URLSearchParams({
grant_type: 'account_credentials',
account_id: process.env.ZOOM_ACCOUNT_ID
}),
{
headers: {
'Authorization': `Basic ${credentials}`,
'Content-Type': 'application/x-www-form-urlencoded'
}
}
);
return response.data.access_token;
}
async function getMeetingDetails(meetingId) {
const token = await getAccessToken();
const response = await axios.get(
`https://api.zoom.us/v2/meetings/${meetingId}`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return response.data;
}
// ============================================
// STEP 2: Connect to WebSocket (zoom-websockets)
// ============================================
async function connectWebSocket() {
const accessToken = await getAccessToken();
const subscriptionId = process.env.ZOOM_WEBSOCKET_SUBSCRIPTION_ID;
const wsUrl = `wss://ws.zoom.us/ws?subscriptionId=${subscriptionId}&access_token=${accessToken}`;
ws = new WebSocket(wsUrl);
ws.on('open', () => {
console.log('✅ WebSocket connection established');
});
ws.on('message', (data) => {
const event = JSON.parse(data);
handleWebSocketEvent(event);
});
ws.on('close', () => {
console.log('❌ WebSocket connection closed. Reconnecting...');
setTimeout(connectWebSocket, 5000);
});
ws.on('error', (error) => {
console.error('WebSocket error:', error);
});
}
// ============================================
// STEP 3: Handle WebSocket Events
// ============================================
function handleWebSocketEvent(event) {
const { event: eventType, payload } = event;
const meetingId = String(payload?.object?.id);
// CRITICAL: Filter events - only process tracked meetings
if (!meetingId || !trackedMeetings.has(meetingId)) {
return;
}
console.log(`📩 WebSocket Event: ${eventType} for meeting ${meetingId}`);
switch (eventType) {
case 'meeting.started':
console.log(`✅ Meeting started: ${payload.object.topic}`);
break;
case 'meeting.ended':
console.log(`🏁 Meeting ended: ${payload.object.topic}`);
trackedMeetings.delete(meetingId);
break;
case 'meeting.participant_joined':
console.log(`👋 ${payload.object.participant.user_name} joined`);
break;
case 'meeting.participant_left':
console.log(`👋 ${payload.object.participant.user_name} left`);
break;
}
}
// ============================================
// USAGE: Track Meeting and Receive Events
// ============================================
async function trackMeeting(meetingId) {
// Get meeting details
const meeting = await getMeetingDetails(meetingId);
// Add to tracked set
trackedMeetings.add(String(meeting.id));
console.log(`✅ Now tracking meeting: ${meeting.topic} (${meeting.id})`);
console.log(` Events will arrive via WebSocket connection`);
return meeting;
}
// Initialize WebSocket connection
connectWebSocket();
// Track specific meetings
trackMeeting('123456789').catch(console.error);
trackMeeting('987654321').catch(console.error);Comparison with Webhooks:
| Aspect | WebSockets | Webhooks |
|---|---|---|
| Latency | Lower (persistent connection) | Higher (new HTTP request per event) |
| Setup | More complex (S2S OAuth required) | Simpler (just endpoint URL) |
| Security | No exposed endpoint | Requires public endpoint + signature verification |
| Best for | Real-time dashboards, high-frequency events | Standard backend processing |
Pattern 3: REST API + Meeting SDK Events (Client-Side In-Meeting)
When to use:
Building custom meeting UI with real-time updates
In-meeting participant tracking
User joins meeting from your web app
Real-time UI state updates (active speaker, video on/off, etc.)
Skills needed: zoom-rest-api → zoom-meeting-sdk
Flow Diagram
┌────────────────────────────────────────────────────────────────┐
│ RUNTIME PHASE (User-initiated): │
│ │
│ Step 1: GET /meetings/{meetingId} (zoom-rest-api) │
│ └── Get meeting number, password │
│ └── Generate SDK signature (JWT) │
│ │
│ Step 2: ZoomMtg.init() + join() (zoom-meeting-sdk) │
│ └── User joins meeting in browser │
│ └── Receive ZoomMtg instance for event listeners │
│ │
│ Step 3: ZoomMtg.inMeetingServiceListener() (zoom-meeting-sdk) │
│ └── Listen to: onUserJoin, onUserLeave, etc. │
│ └── Events ONLY for this specific meeting │
│ └── Real-time UI updates │
└────────────────────────────────────────────────────────────────┘Complete Implementation
Backend: Generate Signature
const KJUR = require('jsrsasign');
// Step 1: Get meeting details
async function getMeetingDetails(meetingId) {
const token = await getAccessToken();
const response = await axios.get(
`https://api.zoom.us/v2/meetings/${meetingId}`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return {
id: response.data.id,
password: response.data.password,
topic: response.data.topic,
join_url: response.data.join_url
};
}
// Generate Meeting SDK signature
function generateSignature(meetingNumber, role) {
const iat = Math.floor(Date.now() / 1000) - 30;
const exp = iat + 60 * 60 * 2; // 2 hours
const header = { alg: 'HS256', typ: 'JWT' };
const payload = {
sdkKey: process.env.ZOOM_SDK_KEY,
mn: String(meetingNumber).replace(/\D/g, ''),
role: parseInt(role, 10), // 0 = participant, 1 = host
iat,
exp,
tokenExp: exp
};
return KJUR.jws.JWS.sign(
'HS256',
JSON.stringify(header),
JSON.stringify(payload),
process.env.ZOOM_SDK_SECRET
);
}
// API endpoint: Get meeting details + signature
app.get('/api/meetings/:meetingId/join', async (req, res) => {
try {
const { meetingId } = req.params;
const { role = 0 } = req.query;
// Get meeting details from Zoom API
const meeting = await getMeetingDetails(meetingId);
// Generate signature for SDK
const signature = generateSignature(meeting.id, role);
res.json({
meetingNumber: meeting.id,
password: meeting.password,
signature: signature,
sdkKey: process.env.ZOOM_SDK_KEY,
topic: meeting.topic
});
} catch (error) {
res.status(error.response?.status || 500).json({
error: error.message
});
}
});Frontend: Join Meeting and Listen to Events
import { ZoomMtg } from '@zoom/meetingsdk';
// Step 1: Get meeting details + signature from backend
async function getMeetingCredentials(meetingId) {
const response = await fetch(`/api/meetings/${meetingId}/join`);
return response.json();
}
// Step 2: Initialize Meeting SDK
async function joinMeeting(meetingId, userName) {
try {
// Get meeting details from backend (includes REST API call)
const credentials = await getMeetingCredentials(meetingId);
// Preload SDK
ZoomMtg.preLoadWasm();
ZoomMtg.prepareWebSDK();
// Initialize SDK
ZoomMtg.init({
leaveUrl: window.location.origin,
patchJsMedia: true,
leaveOnPageUnload: true,
success: () => {
// Join meeting
ZoomMtg.join({
signature: credentials.signature,
sdkKey: credentials.sdkKey,
meetingNumber: credentials.meetingNumber,
passWord: credentials.password,
userName: userName,
success: () => {
console.log('✅ Joined meeting:', credentials.topic);
// Step 3: Subscribe to in-meeting events
subscribeToMeetingEvents();
},
error: (err) => {
console.error('Join error:', err);
}
});
},
error: (err) => {
console.error('Init error:', err);
}
});
} catch (error) {
console.error('Failed to join meeting:', error);
}
}
// Step 3: Listen to Meeting SDK events
function subscribeToMeetingEvents() {
// User join events
ZoomMtg.inMeetingServiceListener('onUserJoin', (data) => {
console.log('👋 User joined:', data);
// data.userId, data.userName
// Update UI: add participant to list
});
// User leave events
ZoomMtg.inMeetingServiceListener('onUserLeave', (data) => {
console.log('👋 User left:', data);
// Update UI: remove participant from list
});
// Active speaker detection
ZoomMtg.inMeetingServiceListener('onActiveSpeaker', (data) => {
console.log('🎤 Active speaker:', data);
// data: [{ userId, userName }]
// Update UI: highlight speaker
});
// Meeting status changes
ZoomMtg.inMeetingServiceListener('onMeetingStatus', (data) => {
console.log('📊 Meeting status:', data);
// status: 1=connecting, 2=connected, 3=disconnected, 4=reconnecting
});
// Chat messages
ZoomMtg.inMeetingServiceListener('onReceiveChatMsg', (data) => {
console.log('💬 Chat message:', data);
// Display in custom UI
});
// Recording status
ZoomMtg.inMeetingServiceListener('onRecordingChange', (data) => {
console.log('🔴 Recording status:', data);
// Show recording indicator
});
// User updates (audio/video state changes)
ZoomMtg.inMeetingServiceListener('onUserUpdate', (data) => {
console.log('🔄 User updated:', data);
// Update UI: show muted/video off indicators
});
}
// Usage
joinMeeting('123456789', 'John Doe');Key Differences from Webhooks/WebSockets:
| Aspect | Meeting SDK Events | Webhooks/WebSockets |
|---|---|---|
| Scope | Meeting-specific (only joined meeting) | Account-level (all meetings) |
| Location | Client-side (browser) | Server-side |
| Authentication | SDK signature (JWT) | OAuth access token |
| Use case | In-meeting UI updates | Backend processing |
| Event types | Participant, audio/video, chat, recording | Meeting lifecycle, participants |
Pattern 4: REST API + RTMS (Bot-Based Real-Time Media + Events)
When to use:
AI transcription, translation, sentiment analysis
Meeting recording bots
Real-time media processing (audio/video streams)
Compliance monitoring
Skills needed: zoom-rest-api → rtms
Flow Diagram
┌────────────────────────────────────────────────────────────────┐
│ SETUP PHASE: │
│ │
│ 1. Configure webhook subscription for meeting.rtms_started │
│ 2. Deploy bot infrastructure │
└────────────────────────────────────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────────┐
│ RUNTIME PHASE: │
│ │
│ Step 1: GET /meetings/{meetingId} (zoom-rest-api) │
│ └── Get meeting details │
│ │
│ Step 2: Wait for meeting.rtms_started webhook │
│ └── Contains rtmsSessionID, meetingUUID │
│ │
│ Step 3: Connect to RTMS WebSocket (rtms) │
│ └── wss://rtms.zoom.us/ws │
│ └── Subscribe to: audio, video, transcript, chat │
│ │
│ Step 4: Receive real-time media + events │
│ └── Audio chunks, video frames, transcripts │
│ └── Events: participant joined/left, speaking status │
└────────────────────────────────────────────────────────────────┘Complete Implementation
See comprehensive implementation: rtms/examples/rtms-bot.md
Quick Overview:
const axios = require('axios');
const WebSocket = require('ws');
// Step 1: Get meeting details
async function getMeetingDetails(meetingId) {
const token = await getAccessToken();
const response = await axios.get(
`https://api.zoom.us/v2/meetings/${meetingId}`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return response.data;
}
// Step 2: Wait for meeting.rtms_started webhook
app.post('/webhooks/zoom', (req, res) => {
const { event, payload } = req.body;
if (event === 'meeting.rtms_started') {
const { rtmsSessionID, meetingUUID } = payload.object;
// Step 3: Connect to RTMS
connectToRTMS(rtmsSessionID, meetingUUID);
}
res.status(200).send();
});
// Step 3: Connect to RTMS WebSocket
async function connectToRTMS(sessionID, meetingUUID) {
const token = await getAccessToken();
const ws = new WebSocket('wss://rtms.zoom.us/ws', {
headers: {
'Authorization': `Bearer ${token}`,
'X-Zoom-Session-ID': sessionID
}
});
ws.on('open', () => {
// Subscribe to media types
ws.send(JSON.stringify({
type: 'subscribe',
mediaTypes: ['audio', 'transcript', 'chat']
}));
});
ws.on('message', (data) => {
const message = JSON.parse(data);
// Step 4: Handle real-time media and events
switch (message.type) {
case 'audio':
processAudioChunk(message.data);
break;
case 'transcript':
console.log(`📝 Transcript: ${message.data.text}`);
break;
case 'chat':
console.log(`💬 Chat: ${message.data.message}`);
break;
case 'participant_joined':
console.log(`👋 ${message.data.user_name} joined`);
break;
case 'participant_left':
console.log(`👋 ${message.data.user_name} left`);
break;
}
});
}
function processAudioChunk(audioData) {
// Process raw audio for transcription, analysis, etc.
}RTMS Events (Different from Webhooks):
| Event Type | Source | Data |
|---|---|---|
participant_joined | RTMS WebSocket | Real-time when user joins |
participant_left | RTMS WebSocket | Real-time when user leaves |
active_speaker_change | RTMS WebSocket | Current speaker info |
audio | RTMS WebSocket | Raw audio stream (PCM) |
video | RTMS WebSocket | Raw video frames |
transcript | RTMS WebSocket | Live transcription |
Pattern 5: REST API + Reports (Historical Data, Not Real Events)
When to use:
Historical analysis, batch processing
Audit logs, compliance reports
No real-time requirements
Backup/recovery systems
Skills needed: zoom-rest-api only
Implementation
// Get meeting details
async function getMeetingDetails(meetingId) {
const token = await getAccessToken();
const response = await axios.get(
`https://api.zoom.us/v2/meetings/${meetingId}`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return response.data;
}
// Poll for meeting participants report (after meeting ends)
async function getMeetingParticipantsReport(meetingId) {
const token = await getAccessToken();
// Get past meeting details
const response = await axios.get(
`https://api.zoom.us/v2/past_meetings/${meetingId}`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return response.data;
}
// Get detailed participant report
async function getParticipantsList(meetingId) {
const token = await getAccessToken();
const response = await axios.get(
`https://api.zoom.us/v2/report/meetings/${meetingId}/participants`,
{ headers: { 'Authorization': `Bearer ${token}` } }
);
return response.data.participants;
}
// Usage: Retrieve meeting + get historical data
async function analyzeMeeting(meetingId) {
// Get meeting metadata
const meeting = await getMeetingDetails(meetingId);
console.log(`Meeting: ${meeting.topic}`);
// Wait for meeting to end, then get reports
// (typically poll or wait for meeting.ended webhook)
const participants = await getParticipantsList(meetingId);
console.log(`Total participants: ${participants.length}`);
participants.forEach(p => {
console.log(`- ${p.name}: ${p.duration} minutes`);
});
}Not Real-Time Events:
Reports API only provides historical data after meeting ends
Not suitable for real-time monitoring
No WebSocket/webhook integration
Use for: auditing, analytics, compliance
Comparison: When to Use Each Pattern
| Pattern | Latency | Scope | Setup Complexity | Best For |
|---|---|---|---|---|
| Webhooks | Medium | Account-level | Low | Standard backend processing |
| WebSockets | Low | Account-level | Medium | Real-time dashboards, no exposed endpoint |
| Meeting SDK | Very Low | Meeting-specific | Low | In-meeting UI, participant views |
| RTMS | Very Low | Meeting-specific | High | AI transcription, recording bots |
| Reports API | N/A (historical) | Account-level | Low | Batch processing, analytics |
Skill Chaining Summary
| Scenario | Skills Chain | Order |
|---|---|---|
| Backend event processing | zoom-rest-api → webhooks | 1. Get meeting, 2. Filter webhook events |
| Low-latency monitoring | zoom-rest-api → zoom-websockets | 1. Get meeting, 2. Filter WebSocket events |
| Custom meeting UI | zoom-rest-api → zoom-meeting-sdk | 1. Get details, 2. Join meeting, 3. Listen to SDK events |
| AI transcription bot | zoom-rest-api → rtms | 1. Get meeting, 2. Wait for webhook, 3. Connect to RTMS |
| Historical analysis | zoom-rest-api only | 1. Get meeting, 2. Poll reports after meeting ends |
Authorization Requirements
All patterns require different OAuth scopes:
| Pattern | Required Scopes |
|---|---|
| REST API | meeting:read:admin or meeting:read |
| Webhooks | Event subscription in app config |
| WebSockets | Server-to-Server OAuth + event subscription |
| Meeting SDK | SDK Key/Secret + signature generation |
| RTMS | meeting:read:admin + RTMS-enabled account |
See also: Authorization Patterns for complete scope validation strategies.
Common Pitfalls
❌ Misconception: "Subscribe to Events for a Specific Meeting"
Reality: Most Zoom event systems are account-level, not meeting-specific.
| What You Think | What Actually Happens |
|---|---|
| "Subscribe to events for meeting 123456789" | You receive events for ALL meetings in the account |
| "Dynamically enable webhooks when meeting starts" | Webhooks are configured at app creation time |
| "Create a webhook subscription per meeting" | One subscription receives events for all meetings |
Solution: Filter events by meeting ID in your handler code.
❌ Misconception: "All Events Are the Same"
Reality: Different event systems provide different event types:
| Event System | Events |
|---|---|
| Webhooks | Meeting lifecycle: started, ended, participant_joined/left, recording_completed |
| WebSockets | Same as webhooks, but lower latency |
| Meeting SDK | In-meeting: onUserJoin, onActiveSpeaker, onUserUpdate, onReceiveChatMsg |
| RTMS | Real-time media: participant events + audio/video streams + transcripts |
Solution: Choose the right event system for your use case (see comparison table above).
Related Use Cases
Meeting Details with Events - Expanded webhook implementation
Meeting Bots - Building RTMS bots for transcription
Recording & Transcription - Download recordings after meeting ends
Resources
Requirements and compatibility
Written for: Claude Code, Claude apps
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.
Needs: Claude Code frontmatter, Needs an MCP server
Security
What our scanner noticed· Medium risk
- Possible data-exfiltration endpoints
- Instructions that use the network
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
- Anthropic (Official)
- Distributed by
- Anthropic
- Source
- anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/general · commit e050c2e
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from partner-built/zoom-plugin/LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Zoom or Anthropic.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download zoom-general.zip