Generated banner for Zoom Apps SDK
Generated logo for Zoom Apps SDK

Zoom Apps SDK

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Software development
  • MIT
  • Medium risk

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

  1. Download the skill as a ZIP:

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

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

  1. Confirm the running context: meeting, webinar, main client, phone, collaborate mode, immersive mode, camera mode, or Layers API.

  2. Configure Marketplace app settings, allowed domains, redirect URIs, and in-client OAuth before implementing SDK calls.

  3. Initialize zoomSdk and gate features by capability and running context.

  4. Design client communication and data flow: frontend SDK calls, backend REST calls, in-client OAuth tokens, and webhook handoff.

  5. Implement advanced client features only after the base app loads reliably: Layers API, breakout rooms, guest mode, collaborate mode, or ZMail.

  6. Debug blank panels, domain allowlist issues, CSP, missing capabilities, running-context mismatch, and OAuth redirect problems independently.

References

Files

examples/guest-mode.md

Guest Mode

Handle unauthenticated meeting participants who haven't authorized your app.

Overview

When a meeting has external guests (non-Zoom users or users who haven't installed your app), they enter your app in an unauthenticated state. Guest mode lets you progressively request authorization.

Three Authorization States

Unauthenticated ──> Authenticated ──> Authorized
     │                     │                │
     │                     │                │
  No Zoom identity    Has Zoom identity    Has OAuth tokens
  External guest      Zoom user, no app    Full app access
  Limited UI          Can promptAuthorize  All APIs available
StateWhogetUserContext ReturnsCan Use APIs
UnauthenticatedExternal guests, no Zoom accountMinimal (no user ID)Very limited
AuthenticatedZoom users who haven't authorized your appName, role (no personal data)Read-only context
AuthorizedUsers who authorized your appFull user dataAll APIs

Detecting State

import zoomSdk from '@zoom/appssdk';

await zoomSdk.config({
  capabilities: ['getUserContext', 'authorize', 'promptAuthorize', 'onAuthorized'],
  version: '0.16'
});

const user = await zoomSdk.getUserContext();

if (user.status === 'authorized') {
  showFullApp();
} else if (user.status === 'authenticated') {
  showLimitedApp();
  showAuthorizeButton();
} else {
  showGuestView();
  showAuthorizeButton();
}

Prompting Authorization

// Show a button that triggers authorization
document.getElementById('authorize-btn').addEventListener('click', async () => {
  try {
    await zoomSdk.promptAuthorize();
  } catch (e) {
    console.error('Authorization prompt failed:', e);
  }
});

// Listen for successful authorization
zoomSdk.addEventListener('onAuthorized', async (event) => {
  const { code, state } = event;

  // Exchange code for tokens on your backend
  await fetch('/api/auth/token', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ code, state })
  });

  // Upgrade UI to full access
  showFullApp();
});

UI Pattern

function showGuestView() {
  document.getElementById('app').innerHTML = `
    <h2>Welcome, Guest!</h2>
    <p>You're viewing this app as a guest. Authorize to unlock all features.</p>
    <div id="limited-content">
      <!-- Show read-only or minimal content -->
    </div>
    <button id="authorize-btn">Authorize App</button>
  `;
}

function showLimitedApp() {
  document.getElementById('app').innerHTML = `
    <h2>Welcome!</h2>
    <p>Authorize to unlock all features.</p>
    <div id="limited-content">
      <!-- Show more content than guest, but still limited -->
    </div>
    <button id="authorize-btn">Authorize for Full Access</button>
  `;
}

function showFullApp() {
  document.getElementById('app').innerHTML = `
    <h2>Full App Access</h2>
    <div id="full-content">
      <!-- All features available -->
    </div>
  `;
}

Host-Required Authorization

Meeting hosts can require all participants to authorize before using the app. This is configured in the Marketplace app settings under the "Guest Mode" feature.

When enabled, unauthenticated/authenticated users see the authorization prompt immediately.

Resources

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