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
references/zmail-sdk.md
Zoom Mail Integration
Integrate with Zoom Mail via REST API and Zoom Apps SDK for mail plugins.
Overview
Important: There is no standalone "ZMail JS SDK". Zoom Mail integration uses:
Zoom Mail REST API - Server-side email operations
Zoom Apps SDK - Build mail plugins that run inside Zoom client
Prerequisites
Zoom Workplace Pro, Standard Pro, Business, or Enterprise account
Zoom Mail enabled (Pro accounts have it by default; Business/Enterprise must enable)
OAuth app with mail scopes
Zoom Mail REST API
Base URL
https://api.zoom.us/v2/emailsKey Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /emails/mailboxes/{email}/messages/send | Send a message |
| POST | /emails/mailboxes/{email}/messages | Create/add message to mailbox |
| POST | /emails/mailboxes/{email}/drafts | Create draft |
| POST | /emails/mailboxes/{email}/labels | Create label |
| GET | /emails/mailboxes/me/profile | Get mailbox profile |
Send Email Example
Emails must be in RFC 2822 format, base64 encoded:
// Generate RFC 2822 compliant message
function generateEmailMessage(from, to, subject, body) {
const message = `From: ${from}\nTo: ${to}\nSubject: ${subject}\n\n${body}`;
return btoa(message); // Base64 encode
}
// Send email via API
async function sendEmail(mailbox, toEmail, subject, body) {
const encodedMessage = generateEmailMessage(mailbox, toEmail, subject, body);
const response = await fetch(
`https://api.zoom.us/v2/emails/mailboxes/${mailbox}/messages/send`,
{
method: 'POST',
headers: {
'Authorization': `Bearer ${accessToken}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
raw: encodedMessage
})
}
);
return response.json();
}
// Usage
await sendEmail(
'[email protected]',
'[email protected]',
'Meeting Follow-up',
'Thank you for attending today\'s meeting.'
);Create Draft
async function createDraft(mailbox, to, subject, body) {
const encodedMessage = generateEmailMessage(mailbox, to, subject, body);
await fetch(
`https://api.zoom.us/v2/emails/mailboxes/${mailbox}/drafts`,
{
method: 'POST',
headers: {
'Authorization': `Bearer ${accessToken}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
raw: encodedMessage
})
}
);
}Get Mailbox Profile
const profile = await fetch(
'https://api.zoom.us/v2/emails/mailboxes/me/profile',
{
headers: { 'Authorization': `Bearer ${accessToken}` }
}
).then(r => r.json());
console.log('Email:', profile.email);Zoom Apps SDK - Mail Plugins
Build apps that run inside Zoom Mail tab using Zoom Apps SDK.
Installation
npm install @zoom/appssdkOr via CDN:
<script src="https://appssdk.zoom.us/sdk.js"></script>Initialize for Mail Context
// IMPORTANT: Do NOT declare "let zoomSdk" - causes redeclaration error
// The SDK defines window.zoomSdk globally
let sdk = window.zoomSdk;
async function init() {
try {
const configResponse = await sdk.config({
popout: true,
capabilities: ['insertContentToMailActiveEditor'],
version: '0.16'
});
console.log('Running in context:', configResponse.runningContext);
// Will be "mailTab" when running in Zoom Mail
} catch (error) {
console.error('Not running inside Zoom client:', error);
}
}Insert Content to Mail Editor
Insert HTML content into the active mail composer:
// Insert content into mail editor (must comply with Tiptap HTML specs)
await sdk.insertContentToMailActiveEditor({
html: '<p>This content will be inserted into the email body.</p>'
});Mail Plugin Use Cases
| Use Case | Description |
|---|---|
| Email Templates | Insert pre-built email templates |
| Signature Manager | Dynamic email signatures |
| Meeting Links | Auto-insert Zoom meeting links |
| CRM Integration | Pull contact info into emails |
| Translation | Translate email content |
Authentication
Server-to-Server OAuth (for REST API)
async function getAccessToken() {
const response = await fetch('https://zoom.us/oauth/token', {
method: 'POST',
headers: {
'Authorization': 'Basic ' + btoa(`${clientId}:${clientSecret}`),
'Content-Type': 'application/x-www-form-urlencoded'
},
body: 'grant_type=client_credentials'
});
const data = await response.json();
return data.access_token; // Valid for 1 hour
}Required Scopes
| Scope | Description |
|---|---|
mail:read | Read mailbox data |
mail:write | Send emails, create drafts |
mail:read:admin | Admin read access |
mail:write:admin | Admin write access |
Limitations
| Limitation | Notes |
|---|---|
| Account requirement | Zoom Workplace Pro+ with Zoom Mail |
| Email format | Must be RFC 2822 compliant, base64 encoded |
| Plugin context | Zoom Apps SDK mail features only work in Mail tab |
| HTML in editor | Must comply with Tiptap specifications |
Resources
Zoom Mail API Docs: https://developers.zoom.us/docs/api/rest/zoom-mail/
Zoom Mail Overview: https://developers.zoom.us/docs/mail/
Zoom Apps SDK: https://github.com/zoom/appssdk
NPM Package: https://www.npmjs.com/package/@zoom/appssdk
Sample Implementation: https://github.com/Wrightlab1/ZoomMailAPI
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