AutoGineer
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
Download ZIP

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

references/events.md

Zoom Apps SDK - Events Reference

Subscribe to events to respond to meeting, user, and app state changes.

IMPORTANT: Register event listeners AFTER successful zoomSdk.config() call. Events must be listed in the capabilities array.

Subscribing to Events

import zoomSdk from '@zoom/appssdk';

await zoomSdk.config({
  capabilities: ['onMeeting', 'onParticipantChange', 'onAuthorized', ...],
  version: '0.16'
});

zoomSdk.addEventListener('onMeeting', (event) => {
  console.log('Meeting event:', event);
});

Meeting Events

onMeeting

Meeting lifecycle changes (start, end, etc.).

zoomSdk.addEventListener('onMeeting', (event) => {
  // event: { action: 'started' | 'ended' | ... }
});
onParticipantChange

Participants join or leave.

zoomSdk.addEventListener('onParticipantChange', (event) => {
  const { participants, action } = event;
  // action: 'join' | 'leave'
  // participants: [{ participantId, screenName, role }]
});
onActiveSpeakerChange

Active speaker changes.

zoomSdk.addEventListener('onActiveSpeakerChange', (event) => {
  const { participantId, screenName } = event;
});
onBreakoutRoomChange

User moves between breakout rooms.

zoomSdk.addEventListener('onBreakoutRoomChange', (event) => {
  // Re-fetch meeting UUID and state for new room
});

User Events

onMyUserContextChange

Current user's context changes (role, name, mute status, etc.).

zoomSdk.addEventListener('onMyUserContextChange', (event) => {
  const { role, screenName } = event;
});
onMyMediaChange

Current user's audio/video status changes.

zoomSdk.addEventListener('onMyMediaChange', (event) => {
  const { audio, video } = event;
  // audio: { muted: true/false }
  // video: { started: true/false }
});

App Events

onShareApp

App sharing status changes.

zoomSdk.addEventListener('onShareApp', (event) => {
  const { isShared } = event;
});
onAppPopout

App popped out to separate window or back.

zoomSdk.addEventListener('onAppPopout', (event) => {
  const { isPopout } = event;
});
onRunningContextChange

Running context changes (e.g., meeting starts while in main client).

zoomSdk.addEventListener('onRunningContextChange', (event) => {
  const { runningContext } = event;
});

Authorization Events

onAuthorized

In-Client OAuth authorization completed.

zoomSdk.addEventListener('onAuthorized', (event) => {
  const { code, state } = event;
  // Send code to backend for token exchange
});

Communication Events

onConnect

Another app instance connected.

zoomSdk.addEventListener('onConnect', (event) => {
  console.log('Other instance connected');
});
onMessage

Message received from connected instance.

zoomSdk.addEventListener('onMessage', (event) => {
  const data = JSON.parse(event.payload);
});

Collaborate Events

onCollaborateChange

Collaborate mode state changes.

zoomSdk.addEventListener('onCollaborateChange', (event) => {
  console.log('Collaborate state:', event);
});

Layers Events

onRenderedAppOpened

Immersive/camera rendering context opened.

zoomSdk.addEventListener('onRenderedAppOpened', (event) => {
  console.log('Rendering context ready');
});

Reaction Events

onReaction

Participant sends a reaction.

zoomSdk.addEventListener('onReaction', (event) => {
  const { participantId, reaction } = event;
});

Removing Listeners

const handler = (event) => { ... };
zoomSdk.addEventListener('onMeeting', handler);

// Later, remove it
zoomSdk.removeEventListener('onMeeting', handler);

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