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
examples/collaborate-mode.md
Collaborate Mode
Real-time shared app state across all meeting participants.
Overview
Collaborate mode lets participants share an app experience simultaneously - like Google Docs for Zoom Apps. When one user makes a change, all participants see it in real time.
Starting Collaborate Mode
import zoomSdk from '@zoom/appssdk';
await zoomSdk.config({
capabilities: [
'startCollaborate', 'onCollaborateChange',
'connect', 'postMessage', 'onConnect', 'onMessage',
'getMeetingUUID'
],
version: '0.16'
});
// Host starts collaborate mode
await zoomSdk.startCollaborate({
shareScreen: true // Also share the app screen
});
// Listen for collaborate state changes
zoomSdk.addEventListener('onCollaborateChange', (event) => {
console.log('Collaborate state changed:', event);
});State Synchronization Patterns
Pattern 1: Server Relay (Socket.io)
Best for apps with a backend. Server is the source of truth.
// Frontend
const socket = io('https://your-server.com');
const meetingUUID = await zoomSdk.getMeetingUUID();
socket.emit('join-room', { roomId: meetingUUID.meetingUUID });
// Send state changes
function updateState(key, value) {
socket.emit('state-update', { key, value });
}
// Receive state changes
socket.on('state-update', ({ key, value }) => {
applyStateChange(key, value);
});Pattern 2: SDK Message Passing
No server needed. Direct peer messaging via connect() + postMessage().
// All participants connect
await zoomSdk.connect();
zoomSdk.addEventListener('onConnect', () => {
console.log('Connected to other instances');
});
// Send state to all connected instances
async function broadcastState(state) {
await zoomSdk.postMessage({
payload: JSON.stringify({ type: 'state-sync', data: state })
});
}
// Receive state from other instances
zoomSdk.addEventListener('onMessage', (event) => {
const message = JSON.parse(event.payload);
if (message.type === 'state-sync') {
applyState(message.data);
}
});Pattern 3: CRDT (Y.js)
Best for collaborative editing (text, whiteboards). Conflict-free resolution.
import * as Y from 'yjs';
import { WebrtcProvider } from 'y-webrtc';
// Use meeting UUID as room name
const meetingUUID = await zoomSdk.getMeetingUUID();
const ydoc = new Y.Doc();
const provider = new WebrtcProvider(meetingUUID.meetingUUID, ydoc, {
signaling: ['wss://your-signaling-server.com']
});
// Shared state automatically syncs via CRDT
const sharedMap = ydoc.getMap('app-state');
// Update state (syncs to all peers automatically)
sharedMap.set('counter', (sharedMap.get('counter') || 0) + 1);
// Observe changes
sharedMap.observe((event) => {
event.keysChanged.forEach((key) => {
console.log(`${key} changed to:`, sharedMap.get(key));
});
});Note: The texteditor sample app uses public Y.js signaling servers. For production, host your own signaling server.
Example: Shared Counter
import zoomSdk from '@zoom/appssdk';
let count = 0;
async function init() {
await zoomSdk.config({
capabilities: ['connect', 'postMessage', 'onConnect', 'onMessage'],
version: '0.16'
});
await zoomSdk.connect();
zoomSdk.addEventListener('onMessage', (event) => {
const msg = JSON.parse(event.payload);
if (msg.type === 'count-update') {
count = msg.count;
render();
}
});
render();
}
async function increment() {
count++;
render();
await zoomSdk.postMessage({
payload: JSON.stringify({ type: 'count-update', count })
});
}
function render() {
document.getElementById('counter').textContent = count;
}Meeting UUID as Room Identifier
Use getMeetingUUID() to get a unique room ID for state synchronization:
const { meetingUUID } = await zoomSdk.getMeetingUUID();
// Use as Socket.io room, Y.js document name, Redis key, etc.This UUID is unique per meeting instance and consistent across all participants.
Resources
Collaborate docs: https://developers.zoom.us/docs/zoom-apps/guides/collaborate-mode/
Sample app: https://github.com/zoom/zoomapps-texteditor-vuejs
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