Zoom Apps SDK
OpenAIOfficialCreated by ZoomDistributed by OpenAI
- Skill
- Tool integration
- Software development
- MIT
- Medium risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The Zoom Apps SDK skill provides a structured approach for developers building applications that run directly inside the Zoom client. It covers the lifecycle of a Zoom App, from initial configuration and context verification to implementing advanced features like the Layers API, in-client OAuth, and inter-instance communication. The skill emphasizes the importance of identifying the correct running context—such as meetings, webinars, or the main client—to ensure features are gated appropriately and the user experience remains consistent across different Zoom environments.
What it does
- Initializes the Zoom Apps SDK with required capabilities.
- Identifies the current running context, such as meeting or main client.
- Facilitates in-client OAuth flows for secure user authentication.
- Enables communication between different app instances.
- Provides access to meeting-specific data and participant information.
- Supports advanced UI and media features like virtual backgrounds and notification management.
When to use it
- When building an application intended to run inside the Zoom client interface.
- When you need to access meeting context, participant lists, or recording status.
- When implementing custom UI overlays or media controls within a Zoom meeting.
- When you need to authenticate users without redirecting them to an external browser.
Advantages
- Provides a unified API for interacting with various Zoom client contexts.
- Supports secure, in-client authentication workflows.
- Enables deep integration with Zoom meeting features and participant data.
- Offers clear patterns for handling cross-instance communication.
Usage examples
- “How do I initialize the Zoom Apps SDK?”
- You must call zoomSdk.config() first, passing in the required capabilities and version to initialize the SDK and declare the features your app intends to use.
- “How can I get the current meeting ID?”
- After initializing the SDK, you can call zoomSdk.getMeetingContext() to retrieve the meetingID, meetingTopic, and meetingStatus.
- “How do I trigger authentication within the Zoom client?”
- Use the zoomSdk.authorize() method to trigger the in-client OAuth flow, which avoids external browser redirects and fires an onAuthorized event upon completion.
- “How do I send a message to another instance of my app?”
- First call zoomSdk.connect() to establish the connection, then use zoomSdk.postMessage() to send a payload to other app instances.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/openai/zoom-apps-sdk/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip zoom-apps-sdk.zip -d .agents/skills
Documentation by Zoom
Zoom Apps SDK
Use this skill when the app runs inside the Zoom client. If the user only needs to embed a meeting in an external app, route to Meeting SDK instead.
Workflow
Confirm the running context: meeting, webinar, main client, phone, collaborate mode, immersive mode, camera mode, or Layers API.
Configure Marketplace app settings, allowed domains, redirect URIs, and in-client OAuth before implementing SDK calls.
Initialize
zoomSdkand gate features by capability and running context.Design client communication and data flow: frontend SDK calls, backend REST calls, in-client OAuth tokens, and webhook handoff.
Implement advanced client features only after the base app loads reliably: Layers API, breakout rooms, guest mode, collaborate mode, or ZMail.
Debug blank panels, domain allowlist issues, CSP, missing capabilities, running-context mismatch, and OAuth redirect problems independently.
References
Full preserved guide: references/full-guide.md
Architecture: concepts/architecture.md
Running contexts: concepts/running-contexts.md
Meeting SDK versus Zoom Apps: concepts/meeting-sdk-vs-zoom-apps.md
Layers API: references/layers-api.md
In-client OAuth: examples/in-client-oauth.md
Common issues: troubleshooting/common-issues.md
Files
- ATTRIBUTION.mdAdded by AutoGineer873 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md3.3 KiB
- SKILL.md1.5 KiB
- agents/openai.yaml130 B
- concepts/architecture.md7.7 KiB
- concepts/meeting-sdk-vs-zoom-apps.md1.0 KiB
- concepts/running-contexts.md5.6 KiB
- concepts/security.md5.4 KiB
- examples/app-communication.md3.6 KiB
- examples/breakout-rooms.md3.2 KiB
- examples/collaborate-mode.md4.1 KiB
- examples/guest-mode.md3.5 KiB
- examples/in-client-oauth.md6.1 KiB
- examples/layers-camera.md5.7 KiB
- examples/layers-immersive.md7.9 KiB
- examples/quick-start.md7.3 KiB
- references/apis.md5.3 KiB
- references/environment-variables.md1.1 KiB
- references/events.md3.8 KiB
- references/full-guide.md24.9 KiB
- references/layers-api.md15.8 KiB
- references/oauth.md5.3 KiB
- references/zmail-sdk.md5.5 KiB
- troubleshooting/common-issues.md4.3 KiB
- troubleshooting/debugging.md3.5 KiB
- troubleshooting/forum-top-questions.md1.1 KiB
- troubleshooting/migration.md3.0 KiB
concepts/security.md
Security
Overview
Zoom Apps must meet security requirements for Marketplace approval. This covers required headers, CSP configuration, cookie security, and token storage.
Required OWASP Headers
Zoom's security review requires these HTTP headers on all responses:
| Header | Required Value | Purpose |
|---|---|---|
Strict-Transport-Security | max-age=31536000 | Force HTTPS for 1 year |
X-Content-Type-Options | nosniff | Prevent MIME type sniffing |
Content-Security-Policy | frame-ancestors 'self' zoom.us *.zoom.us | Allow Zoom to embed your app |
Referrer-Policy | same-origin | Limit referrer info |
X-Frame-Options | ALLOW-FROM zoom.us | Legacy frame control |
Express Implementation
app.use((req, res, next) => {
res.setHeader('Strict-Transport-Security', 'max-age=31536000');
res.setHeader('X-Content-Type-Options', 'nosniff');
res.setHeader('Content-Security-Policy',
"frame-ancestors 'self' zoom.us *.zoom.us"
);
res.setHeader('Referrer-Policy', 'same-origin');
next();
});Critical: The frame-ancestors CSP directive is what allows Zoom's embedded browser to load your app. Without it, the browser blocks the frame.
TLS Requirements
HTTPS required for all endpoints (minimum TLS 1.2)
HTTP redirects to HTTPS
Valid SSL certificate (self-signed will fail)
ngrok provides HTTPS automatically for local development
Cookie Security
Zoom's embedded browser requires specific cookie settings:
// Express cookie-session example
app.use(require('cookie-session')({
name: 'session',
keys: [process.env.SESSION_SECRET],
maxAge: 24 * 60 * 60 * 1000, // 24 hours
sameSite: 'none', // REQUIRED - Zoom embeds your app cross-origin
secure: true // REQUIRED - SameSite=None requires Secure
}));Why SameSite=None? Your app runs inside Zoom's embedded browser, which is a different origin. Without SameSite=None, the browser won't send cookies to your server, and sessions break silently.
PKCE OAuth Security
All Zoom Apps OAuth flows should use PKCE (Proof Key for Code Exchange):
const crypto = require('crypto');
// Generate PKCE pair
const verifier = crypto.randomBytes(32).toString('hex');
const challenge = crypto.createHash('sha256')
.update(verifier)
.digest('base64url');
// Store verifier in session (server-side)
req.session.codeVerifier = verifier;
// Send challenge to frontend (or include in OAuth redirect URL)
res.json({ codeChallenge: challenge, state: req.session.state });PKCE prevents authorization code interception attacks. The code_verifier never leaves your server.
Token Storage
Never store tokens in the frontend (localStorage, sessionStorage, cookies).
| Storage | When to Use | Security |
|---|---|---|
| Redis | Multi-instance servers, production | Fast, TTL support, scalable |
| Encrypted session | Single server, simple apps | Tied to server process |
| Firestore/DynamoDB | Serverless (Firebase/Lambda) | Persistent, managed |
| Database (encrypted) | Complex apps with user accounts | Full control, encrypted at rest |
// Redis token storage example
const Redis = require('ioredis');
const redis = new Redis(process.env.REDIS_URL);
async function storeTokens(zoomUserId, tokens) {
await redis.set(
`zoom:tokens:${zoomUserId}`,
JSON.stringify(tokens),
'EX', tokens.expires_in // Auto-expire with token
);
}
async function getTokens(zoomUserId) {
const data = await redis.get(`zoom:tokens:${zoomUserId}`);
return data ? JSON.parse(data) : null;
}State Parameter (CSRF Protection)
Always validate the OAuth state parameter:
const crypto = require('crypto');
// Generate state before OAuth redirect
const state = crypto.randomBytes(16).toString('hex');
req.session.oauthState = state;
// Validate state on callback
app.get('/auth', (req, res) => {
if (req.query.state !== req.session.oauthState) {
return res.status(403).send('Invalid state - possible CSRF attack');
}
// Proceed with token exchange
});Data Access Layers
| Layer | What You Access | Authorization | Risk Level |
|---|---|---|---|
| SDK (contextual) | Meeting context, user info, UI controls | config() capabilities | Low - scoped to current context |
| REST API (server-side) | Full Zoom API (users, meetings, recordings) | OAuth access tokens | Medium - broader data access |
| X-Zoom-App-Context | User identity, meeting info | Client secret decryption | Low - read-only identity |
Principle of least privilege: Only request the OAuth scopes and SDK capabilities you actually need.
Marketplace Security Review Checklist
[ ] All OWASP headers set on every response
[ ] HTTPS enforced (no HTTP endpoints)
[ ] PKCE used for OAuth flows
[ ] State parameter validated on OAuth callbacks
[ ] Tokens stored server-side (never in frontend)
[ ] Token refresh implemented (tokens expire in 1 hour)
[ ]
SameSite=None; Secureon cookies[ ] CSP allows
frame-ancestors zoom.us *.zoom.us[ ] No sensitive data logged to console in production
[ ] Environment variables for all secrets (no hardcoded credentials)
Resources
Security docs: https://developers.zoom.us/docs/zoom-apps/security/
OWASP headers: https://developers.zoom.us/docs/zoom-apps/security/owasp/
Requirements and compatibility
Written for: OpenAI Codex
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
What our scanner noticed· Medium risk
- Possible data-exfiltration endpoints
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Zoom
- Publisher
- OpenAI (Official)
- Distributed by
- OpenAI
- Source
- openai/plugins · plugins/zoom/skills/zoom-apps-sdk · commit d420d13
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from plugins/zoom/LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Zoom or OpenAI.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download zoom-apps-sdk.zip