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://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

concepts/running-contexts.md

Running Contexts

Overview

A Zoom App can run in multiple surfaces within the Zoom client. The runningContext property returned by config() tells you where your app is currently loaded.

const configResponse = await zoomSdk.config({
  capabilities: ['getMeetingContext', 'getUserContext', ...],
  version: '0.16'
});

console.log(configResponse.runningContext);
// 'inMeeting' | 'inMainClient' | 'inWebinar' | 'inImmersive' | ...

All Running Contexts

ContextSurfaceMeeting APIsUser APIsLayers APIsNotes
inMeetingMeeting sidebarYesYesYesMost common context
inMainClientMain client panelNoYesNoHome tab, no meeting running
inWebinarWebinar sidebarYesYesYesHost/panelist initially
inImmersiveLayers full-screenLimitedYesYesAfter runRenderingContext
inCameraCamera modeLimitedYesCamera onlyVirtual camera overlay
inCollaborateCollaborate modeYesYesNoShared state context
inPhoneZoom PhoneNoYesNoPhone call app surface
inChatTeam ChatNoYesNoChat sidebar

Context-Specific Behavior

inMeeting (Most Common)

The primary context. Your app appears as a sidebar panel during a meeting.

if (configResponse.runningContext === 'inMeeting') {
  const meeting = await zoomSdk.getMeetingContext();
  console.log('Meeting ID:', meeting.meetingID);
  console.log('Topic:', meeting.meetingTopic);

  const user = await zoomSdk.getUserContext();
  console.log('Name:', user.screenName);
  console.log('Role:', user.role); // 'host' | 'coHost' | 'attendee'
}

Available: All meeting APIs, sharing, invitations, breakout rooms, recording.

inMainClient

Your app runs in the main Zoom window (not during a meeting). Used for dashboards, settings, pre-meeting setup.

if (configResponse.runningContext === 'inMainClient') {
  // NO meeting APIs available - getMeetingContext() will fail
  const user = await zoomSdk.getUserContext();
  console.log('Name:', user.screenName);

  // Can still use connect() to sync with meeting instance later
}

Key limitation: No meeting context, no participants, no sharing.

inWebinar

Similar to inMeeting but for webinars. Initially only available to host and panelists.

if (configResponse.runningContext === 'inWebinar') {
  const user = await zoomSdk.getUserContext();
  // role: 'host' | 'panelist' | 'attendee'
  if (user.role === 'attendee') {
    // Limited functionality for attendees
  }
}
inImmersive / inCamera

Layers API contexts. Your app has taken over the video rendering.

  • inImmersive: Full-screen custom layout (replaces gallery view)

  • inCamera: Overlay on user's camera feed

See Layers API Reference for details.

Multiple Instances

A Zoom App can have two instances running simultaneously:

  1. Main client instance (inMainClient) - Always available

  2. Meeting instance (inMeeting) - Created when user opens app in meeting

Instance Communication

Use connect() and postMessage() to sync between instances:

// Both instances call connect()
await zoomSdk.connect();

// Listen for connection
zoomSdk.addEventListener('onConnect', (event) => {
  console.log('Connected to other instance');
});

// Send data to other instance
await zoomSdk.postMessage({ type: 'settings', data: mySettings });

// Receive data from other instance
zoomSdk.addEventListener('onMessage', (event) => {
  const { type, data } = JSON.parse(event.payload);
  if (type === 'settings') {
    applySettings(data);
  }
});

Pattern: Pre-Meeting Setup

Main Client Instance              Meeting Instance
─────────────────────             ─────────────────
User configures settings    -->   connect() + listen
Store in state              -->   onConnect fires
                                  postMessage('getSettings')
onMessage('getSettings')    -->
postMessage(settings)       -->   onMessage(settings)
                                  Apply settings to meeting

Detecting Context at Runtime

import zoomSdk from '@zoom/appssdk';

async function init() {
  const config = await zoomSdk.config({
    capabilities: [
      'getMeetingContext', 'getUserContext', 'getRunningContext',
      'connect', 'postMessage', 'onConnect', 'onMessage',
      'shareApp', 'runRenderingContext'
    ],
    version: '0.16'
  });

  switch (config.runningContext) {
    case 'inMeeting':
    case 'inWebinar':
      initMeetingUI();
      break;
    case 'inMainClient':
      initDashboardUI();
      break;
    case 'inImmersive':
    case 'inCamera':
      initLayersUI();
      break;
    default:
      initFallbackUI();
  }
}

Checking API Availability

Not all APIs are available in all contexts. Use getSupportedJsApis() to check:

const { supportedApis } = await zoomSdk.getSupportedJsApis();

if (supportedApis.includes('authorize')) {
  // In-Client OAuth is available
  showAuthButton();
}

if (supportedApis.includes('runRenderingContext')) {
  // Layers API is available
  showLayersButton();
}

Also check configResponse.unsupportedApis after config() for capabilities that were requested but not available in the current client version.

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