Zoom Apps SDK

From the author

Use when using Apps SDK.

— the description by Zoom

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://mp-staging.autogineer.com/agent-skills/openai/zoom-apps-sdk/download

Unzip 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

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 zoomSdk and 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

troubleshooting/common-issues.md

Common Issues

Quick diagnostics for Zoom Apps SDK problems.

Diagnostic Table

Issue	Cause	Solution
App shows blank panel	Domain not in allowlist	Marketplace > Feature > Add Allow List > add your domain
`zoomSdk is not defined`	SDK script not loaded	Add `<script src="https://appssdk.zoom.us/sdk.js"></script>`
`SyntaxError: redeclaration of non-configurable global property`	Declared `let zoomSdk`	Use `let sdk = window.zoomSdk` instead
`config()` throws error	Not running in Zoom client	Wrap in try/catch, show browser fallback UI
`config()` hangs forever	SDK not initialized	Add 3-second timeout fallback
API call fails silently	Missing OAuth scope	Add required scopes in Marketplace > Scopes tab
`authorize()` doesn't work	Wrong OAuth flow	Use In-Client OAuth: `authorize()` + `onAuthorized`
`postMessage` not received	Instances not connected	Call `connect()` first, wait for `onConnect`
`runRenderingContext` fails	Missing capability	Add `'runRenderingContext'` to config() capabilities
App works then stops	Tunnel URL changed (ngrok/cloudflared/etc.)	Update every Marketplace URL that points at your tunnel domain (home page, redirect URLs, etc.)
CORS errors	Backend URL mismatch	Ensure frontend fetches from same-origin or configure CORS
Cookies not persisting	Wrong cookie settings	Set `sameSite: 'none', secure: true`
OAuth token exchange 400	Wrong redirect URI	Ensure redirect URI matches exactly in Marketplace and code
403 from Zoom REST API	Token expired	Implement token refresh with `refresh_token`
App loads in browser but not in Zoom	CSP headers wrong	Add `frame-ancestors 'self' zoom.us *.zoom.us`
`unsupportedApis` contains your API	Old Zoom client	User needs to update Zoom client
Collaborate/Layers APIs missing	Host privileges or client/version mismatch	Check `unsupportedApis` + `clientVersion`; ensure required features enabled in Marketplace; test as meeting host where required
drawImage fails in camera mode	CEF not ready	Add retry with exponential backoff (see camera-mode example)

Error Codes

Common SDK error codes from config() and API calls:

Code	Meaning	Fix
`INVALID_PARAMETERS`	Wrong argument format	Check API docs for correct parameter shape
`NOT_SUPPORTED`	API not available in this context	Check running context and unsupportedApis
`PERMISSION_DENIED`	Missing capability or scope	Add to config() capabilities AND Marketplace scopes
`INTERNAL_ERROR`	SDK internal failure	Retry, check Zoom client version
`NOT_CONFIGURED`	config() not called yet	Call config() before any other SDK method

Quick Diagnostic Workflow

App doesn't work?
    │
    ├─ Blank panel, no errors?
    │       └─ Domain allowlist. Check Marketplace > Feature > Add Allow List
    │
    ├─ JavaScript error in console?
    │       ├─ "redeclaration" → Use `let sdk = window.zoomSdk`
    │       ├─ "not defined" → SDK script not loaded
    │       └─ "not configured" → Call config() first
    │
    ├─ config() fails?
    │       ├─ In browser → Expected. Not running in Zoom.
    │       └─ In Zoom → Check capabilities match scopes
    │
    ├─ API call returns error?
    │       ├─ PERMISSION_DENIED → Add scope in Marketplace
    │       ├─ NOT_SUPPORTED → Wrong running context
    │       └─ INVALID_PARAMETERS → Check argument format
    │
    └─ Works locally, fails after deploy?
            ├─ Domain allowlist updated?
            ├─ HTTPS configured?
            └─ Cookies: SameSite=None, Secure=true?

Enable SDK Debug Logging

// Check supported APIs at runtime
const { supportedApis } = await zoomSdk.getSupportedJsApis();
console.log('Supported APIs:', supportedApis);

// Check what was unsupported after config
const config = await zoomSdk.config({...});
console.log('Unsupported:', config.unsupportedApis);
console.log('Client version:', config.clientVersion);
console.log('Running context:', config.runningContext);

Resources

Debugging guide: debugging.md
Migration guide: migration.md

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.

Web Artifacts Builder
AnthropicOfficial
A structured workflow for developing and bundling complex, multi-component React artifacts for Claude.
Software developmentClaude CodeClaude appsOpenAI Codex+14 more
Apache-2.0Medium riskHas scriptsGitHub stars of the source repository188.6k
Frontend UI Engineering
Addy Osmani· Community
Engineering standards for building accessible, responsive, and production-ready frontend user interfaces.
Software developmentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository113.9k
Ask Sonner
Emil Kowalski· Community
A comprehensive guide for implementing, styling, and troubleshooting the Sonner toast notification library in React applications.
Software developmentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository54.3k
Pick UI Library
Emil Kowalski· Community
Get recommendations for frontend UI libraries based on a curated, opinionated list.
Software developmentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository54.3k
Animate Expo
Emil Kowalski· Community
A senior mobile engineering guide for building React Native and Expo animations that feel correct on real devices.
Software developmentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository54.3k
Prototype
Emil Kowalski· Community
A design engineering workflow for building and comparing distinct UI variants using an isolated picker harness.
Software developmentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository54.3k

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download zoom-apps-sdk.zip