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://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
references/authorization-patterns.md
Authorization Patterns
Permission validation middleware and role-based access control for Zoom API integrations.
Note: These are implementation patterns for YOUR application when building Zoom integrations. These are not Zoom's internal authorization mechanisms - they are examples of how to structure authorization logic in your own backend.
Overview
When chaining multiple Zoom API calls, each step may require different scopes and permissions. This document provides patterns for validating authorization at each step before proceeding.
Authorization Flow
┌─────────────────────────────────────────────────────────────────────────┐
│ AUTHORIZATION VALIDATION FLOW │
└─────────────────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────────────────┐
│ 1. Check Token Validity │
│ └── Is token expired? → Refresh or re-authenticate │
│ └── Is token revoked? → Re-authenticate │
└─────────────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────────┐
│ 2. Validate Required Scopes │
│ └── Does token have scopes for this operation? │
│ └── If missing → Return 403 with required scopes │
└─────────────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────────┐
│ 3. Check Resource Permissions │
│ └── Does user have access to this resource? │
│ └── Is user admin/owner/member? │
└─────────────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────────────┐
│ 4. Execute Operation │
│ └── Call Zoom API │
│ └── Handle API-level authorization errors │
└─────────────────────────────────────────────────────────────────────────┘Scope Validation Middleware
Express.js Middleware
const axios = require('axios');
/**
* Middleware to validate OAuth token has required scopes
* @param {string[]} requiredScopes - Scopes required for this route
*/
function requireScopes(requiredScopes) {
return async (req, res, next) => {
const token = req.headers.authorization?.replace('Bearer ', '');
if (!token) {
return res.status(401).json({
error: 'unauthorized',
message: 'No access token provided'
});
}
try {
// Get token info to check scopes
const tokenInfo = await getTokenInfo(token);
// Check if token has all required scopes
const tokenScopes = tokenInfo.scope.split(' ');
const missingScopes = requiredScopes.filter(
scope => !tokenScopes.includes(scope)
);
if (missingScopes.length > 0) {
return res.status(403).json({
error: 'insufficient_scope',
message: 'Token missing required scopes',
required_scopes: requiredScopes,
missing_scopes: missingScopes,
your_scopes: tokenScopes
});
}
// Attach token info to request for downstream use
req.zoomToken = tokenInfo;
req.zoomScopes = tokenScopes;
next();
} catch (error) {
if (error.response?.status === 401) {
return res.status(401).json({
error: 'invalid_token',
message: 'Token is invalid or expired'
});
}
next(error);
}
};
}
/**
* Get token information including scopes
*
* IMPORTANT: Scopes are returned during OAuth token exchange, not from API calls.
* You should store the scopes when you receive the access token.
*/
async function getTokenInfo(accessToken) {
// For Server-to-Server OAuth: Decode JWT to get scopes
const parts = accessToken.split('.');
if (parts.length === 3) {
const payload = JSON.parse(Buffer.from(parts[1], 'base64').toString());
return {
scope: payload.scope || '',
exp: payload.exp,
aud: payload.aud
};
}
// For User OAuth tokens: Scopes are NOT available from API responses.
// You must store scopes when you receive them during token exchange.
//
// During OAuth token exchange, the response includes:
// {
// "access_token": "...",
// "token_type": "bearer",
// "scope": "user:read meeting:write ...", <-- Store this!
// "expires_in": 3600
// }
//
// Store the scope in your database alongside the token.
throw new Error(
'User OAuth token scopes must be stored during token exchange. ' +
'Cannot retrieve scopes from an opaque access token.'
);
}
/**
* Example: Store scopes during OAuth token exchange
*/
async function handleOAuthCallback(code) {
const response = await axios.post('https://zoom.us/oauth/token', null, {
params: {
grant_type: 'authorization_code',
code: code,
redirect_uri: REDIRECT_URI
},
auth: {
username: CLIENT_ID,
password: CLIENT_SECRET
}
});
const { access_token, refresh_token, scope, expires_in } = response.data;
// IMPORTANT: Store the scope along with the token
await saveTokenToDatabase({
accessToken: access_token,
refreshToken: refresh_token,
scope: scope, // <-- Store this for later permission checks
expiresAt: Date.now() + (expires_in * 1000)
});
return { access_token, scope };
}
// Usage
const express = require('express');
const app = express();
// Route requiring meeting:read scope
app.get('/api/meetings/:id',
requireScopes(['meeting:read']),
async (req, res) => {
// Token already validated, proceed with API call
const meeting = await getMeeting(req.params.id, req.headers.authorization);
res.json(meeting);
}
);
// Route requiring multiple scopes
app.post('/api/users/:id/meetings',
requireScopes(['user:read', 'meeting:write']),
async (req, res) => {
const meeting = await createMeeting(req.params.id, req.body, req.headers.authorization);
res.json(meeting);
}
);Scope Requirements by Operation
| Operation | User Scope | Admin Scope (S2S) |
|---|---|---|
| Get own user info | user:read | user:read:admin |
| List all users | N/A | user:read:admin |
| Create user | N/A | user:write:admin |
| Get own meetings | meeting:read | meeting:read:admin |
| Get any user's meetings | N/A | meeting:read:admin |
| Create meeting for self | meeting:write | meeting:write:admin |
| Create meeting for others | N/A | meeting:write:admin |
| List own recordings | recording:read | recording:read:admin |
| List any user's recordings | N/A | recording:read:admin |
| Delete own recording | recording:write | recording:write:admin |
| Delete any recording | N/A | recording:write:admin |
| Access own phone | phone:read | phone:read:admin |
| Access any user's phone | N/A | phone:read:admin |
| Manage phone settings | phone:write | phone:write:admin |
Note: "N/A" means this operation requires admin-level scopes and cannot be done with user-level OAuth.
Role-Based Access Control
Define Roles
/**
* Role definitions with allowed scopes
*/
const ROLES = {
admin: {
scopes: [
'user:read:admin', 'user:write:admin',
'meeting:read:admin', 'meeting:write:admin',
'recording:read:admin', 'recording:write:admin',
'account:read:admin', 'account:write:admin'
],
description: 'Full administrative access'
},
manager: {
scopes: [
'user:read:admin',
'meeting:read:admin', 'meeting:write:admin',
'recording:read:admin'
],
description: 'Manage meetings and view users'
},
user: {
scopes: [
'user:read',
'meeting:read', 'meeting:write',
'recording:read'
],
description: 'Manage own meetings and recordings'
},
viewer: {
scopes: [
'meeting:read',
'recording:read'
],
description: 'View-only access'
}
};
/**
* Check if user role has required scope
*/
function roleHasScope(role, requiredScope) {
const roleConfig = ROLES[role];
if (!roleConfig) return false;
return roleConfig.scopes.some(scope => {
// Exact match
if (scope === requiredScope) return true;
// Admin scope covers non-admin version
// e.g., meeting:read:admin covers meeting:read
if (scope.endsWith(':admin')) {
const baseScope = scope.replace(':admin', '');
if (baseScope === requiredScope) return true;
}
return false;
});
}
/**
* Middleware to require a specific role
*/
function requireRole(allowedRoles) {
return (req, res, next) => {
const userRole = req.user?.role; // From your auth system
if (!userRole || !allowedRoles.includes(userRole)) {
return res.status(403).json({
error: 'forbidden',
message: 'Insufficient role permissions',
required_roles: allowedRoles,
your_role: userRole || 'none'
});
}
next();
};
}
// Usage
app.delete('/api/users/:id',
requireRole(['admin']),
requireScopes(['user:write:admin']),
async (req, res) => {
// Only admins can delete users
await deleteUser(req.params.id);
res.json({ success: true });
}
);Permission Checking Between Chained Operations
Chain Validation Pattern
/**
* Validate permissions for a multi-step operation
* before executing any steps
*/
async function validateChainPermissions(operations, tokenScopes) {
const allRequiredScopes = new Set();
for (const op of operations) {
for (const scope of op.requiredScopes) {
allRequiredScopes.add(scope);
}
}
const missingScopes = [...allRequiredScopes].filter(
scope => !tokenScopes.includes(scope)
);
if (missingScopes.length > 0) {
return {
valid: false,
missingScopes,
message: `Cannot complete operation chain. Missing scopes: ${missingScopes.join(', ')}`
};
}
return { valid: true };
}
/**
* Execute a chain of operations with permission validation
*/
async function executeAuthorizedChain(operations, accessToken) {
// Get token scopes
const tokenInfo = await getTokenInfo(accessToken);
const tokenScopes = tokenInfo.scope.split(' ');
// Validate all permissions upfront
const validation = await validateChainPermissions(operations, tokenScopes);
if (!validation.valid) {
throw new Error(validation.message);
}
// Execute operations in sequence
const results = [];
for (const op of operations) {
console.log(`Executing: ${op.name}`);
try {
const result = await op.execute(accessToken, results);
results.push({ name: op.name, success: true, data: result });
} catch (error) {
// Check if it's an authorization error
if (error.response?.status === 403) {
throw new Error(`Authorization failed at step "${op.name}": ${error.response.data.message}`);
}
throw error;
}
}
return results;
}
// Example: User + Meeting creation chain
const userMeetingChain = [
{
name: 'createUser',
requiredScopes: ['user:write:admin'],
execute: async (token, previousResults) => {
return await createUser({
email: '[email protected]',
firstName: 'New',
lastName: 'User'
}, token);
}
},
{
name: 'createMeeting',
requiredScopes: ['meeting:write:admin'],
execute: async (token, previousResults) => {
const user = previousResults.find(r => r.name === 'createUser').data;
return await createMeeting(user.id, {
topic: 'Onboarding Meeting'
}, token);
}
}
];
// Usage
try {
const results = await executeAuthorizedChain(userMeetingChain, accessToken);
console.log('Chain completed:', results);
} catch (error) {
console.error('Chain failed:', error.message);
}Graceful Degradation
Handle Partial Permissions
/**
* Execute with graceful degradation when permissions are partial
*/
async function executeWithDegradation(operations, accessToken) {
const tokenInfo = await getTokenInfo(accessToken);
const tokenScopes = tokenInfo.scope.split(' ');
const results = [];
for (const op of operations) {
// Check if we have permission for this operation
const hasPermission = op.requiredScopes.every(
scope => tokenScopes.includes(scope)
);
if (!hasPermission) {
if (op.required) {
// Required operation - fail the chain
throw new Error(`Missing required scopes for ${op.name}: ${op.requiredScopes.join(', ')}`);
} else {
// Optional operation - skip with warning
console.warn(`Skipping ${op.name}: insufficient permissions`);
results.push({
name: op.name,
skipped: true,
reason: 'insufficient_permissions',
required_scopes: op.requiredScopes
});
continue;
}
}
// Execute operation
const result = await op.execute(accessToken, results);
results.push({ name: op.name, success: true, data: result });
}
return results;
}
// Example with optional operations
const meetingWithOptionalRecording = [
{
name: 'getMeeting',
required: true,
requiredScopes: ['meeting:read'],
execute: async (token) => getMeetingDetails(meetingId, token)
},
{
name: 'getRecordings',
required: false, // Optional - won't fail chain
requiredScopes: ['recording:read'],
execute: async (token, prev) => {
const meeting = prev.find(r => r.name === 'getMeeting').data;
return getRecordings(meeting.uuid, token);
}
}
];Authorization Decision Flowchart
┌──────────────────────────────────────────────────────────────────────────┐
│ AUTHORIZATION DECISION FLOW │
└──────────────────────────────────────────────────────────────────────────┘
┌─────────────────┐
│ Receive Request │
└────────┬────────┘
│
▼
┌────────────────────────┐
│ Is token present? │
└───────────┬────────────┘
│
┌───────────┴───────────┐
│ NO │ YES
▼ ▼
┌───────────────┐ ┌────────────────────┐
│ Return 401 │ │ Is token valid? │
│ Unauthorized │ └─────────┬──────────┘
└───────────────┘ │
┌───────────┴───────────┐
│ NO │ YES
▼ ▼
┌───────────────┐ ┌────────────────────┐
│ Return 401 │ │ Has required │
│ Invalid Token │ │ scopes? │
└───────────────┘ └─────────┬──────────┘
│
┌───────────┴───────────┐
│ NO │ YES
▼ ▼
┌───────────────┐ ┌────────────────────┐
│ Return 403 │ │ Has resource │
│ Insufficient │ │ access? │
│ Scope │ └─────────┬──────────┘
└───────────────┘ │
┌───────────┴───────────┐
│ NO │ YES
▼ ▼
┌───────────────┐ ┌────────────────┐
│ Return 403 │ │ Execute │
│ Forbidden │ │ Operation │
└───────────────┘ └────────────────┘Common Authorization Errors
| Status | Error | Cause | Solution |
|---|---|---|---|
| 401 | invalid_token | Token expired or revoked | Refresh token or re-authenticate |
| 401 | unauthorized | No token provided | Include Authorization header |
| 403 | insufficient_scope | Token missing required scope | Request additional scopes |
| 403 | forbidden | User lacks resource access | Check user permissions |
| 403 | access_denied | Admin-only operation | Use admin account |
Best Practices
Validate upfront - Check all permissions before starting a chain
Fail fast - Return clear error messages with required scopes
Graceful degradation - Skip optional steps rather than fail entirely
Audit logging - Log all authorization decisions
Principle of least privilege - Request only needed scopes
Token caching - Cache token info to avoid repeated validation calls
Real-World Examples
See these use-cases for authorization patterns in action:
User + Meeting Creation - Multi-step provisioning with scope validation
Meeting Details with Events - REST API + webhooks with permission checking
Meeting Automation - Meeting management with admin scope requirements
Resources
OAuth Scopes Reference: https://developers.zoom.us/docs/integrations/oauth-scopes/
API Error Codes: https://developers.zoom.us/docs/api/rest/error-handling/
Authentication Guide: authentication.md
Scopes Reference: scopes.md
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