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

examples/in-client-oauth.md

In-Client OAuth with PKCE

Authorize users without leaving the Zoom client. Best UX for returning users.

Why In-Client OAuth?

ApproachUXWhen to Use
Web redirectOpens browser, redirects backInitial install from Marketplace
In-ClientPopup inside Zoom, no redirectSubsequent authorizations, best UX

Flow

Frontend                          Backend                         Zoom
────────                          ────────                        ────
GET /api/auth/challenge    -->
                           <--    { codeChallenge, state }
                                  (stores code_verifier in session)

zoomSdk.authorize({        -->                               -->  Shows "Authorize" popup
  codeChallenge, state                                            to user
})

onAuthorized fires         <--                               <--  User clicks "Allow"
{ code, state }

POST /api/auth/token       -->
{ code, state }                   Validates state
                                  Exchanges code + verifier
                                  for access_token
                           <--    { success: true }

Frontend Implementation

import zoomSdk from '@zoom/appssdk';

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

  // Check if already authorized
  try {
    const response = await fetch('/api/auth/status');
    const { authorized } = await response.json();
    if (authorized) {
      showApp();
      return;
    }
  } catch (e) {
    // Not authorized yet
  }

  // Set up authorization listener BEFORE calling authorize
  zoomSdk.addEventListener('onAuthorized', async (event) => {
    const { code, state } = event;

    const response = await fetch('/api/auth/token', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ code, state })
    });

    if (response.ok) {
      showApp();
    } else {
      showError('Authorization failed');
    }
  });

  // Get challenge and start authorization
  const challengeResponse = await fetch('/api/auth/challenge');
  const { codeChallenge, state } = await challengeResponse.json();

  await zoomSdk.authorize({ codeChallenge, state });
}

Backend Implementation

const crypto = require('crypto');
const express = require('express');
const axios = require('axios');
const router = express.Router();

// Generate PKCE challenge
router.get('/api/auth/challenge', (req, res) => {
  const verifier = crypto.randomBytes(32).toString('hex');
  const challenge = crypto.createHash('sha256')
    .update(verifier)
    .digest('base64url');
  const state = crypto.randomBytes(16).toString('hex');

  // Store in session (server-side only)
  req.session.codeVerifier = verifier;
  req.session.state = state;

  res.json({ codeChallenge: challenge, state });
});

// Exchange authorization code for tokens
router.post('/api/auth/token', async (req, res) => {
  const { code, state } = req.body;

  // Validate state (CSRF protection)
  if (state !== req.session.state) {
    return res.status(403).json({ error: 'Invalid state' });
  }

  try {
    const tokenResponse = await axios.post('https://zoom.us/oauth/token', null, {
      params: {
        grant_type: 'authorization_code',
        code,
        redirect_uri: process.env.ZOOM_APP_REDIRECT_URI,
        code_verifier: req.session.codeVerifier
      },
      headers: {
        'Authorization': 'Basic ' + Buffer.from(
          `${process.env.ZOOM_APP_CLIENT_ID}:${process.env.ZOOM_APP_CLIENT_SECRET}`
        ).toString('base64')
      }
    });

    // Store tokens securely (session, Redis, or database)
    req.session.tokens = {
      access_token: tokenResponse.data.access_token,
      refresh_token: tokenResponse.data.refresh_token,
      expires_at: Date.now() + (tokenResponse.data.expires_in * 1000)
    };

    // Clean up PKCE data
    delete req.session.codeVerifier;
    delete req.session.state;

    res.json({ success: true });
  } catch (error) {
    console.error('Token exchange failed:', error.response?.data || error.message);
    res.status(500).json({ error: 'Token exchange failed' });
  }
});

// Check authorization status
router.get('/api/auth/status', (req, res) => {
  const tokens = req.session.tokens;
  const authorized = tokens && tokens.expires_at > Date.now();
  res.json({ authorized });
});

// Token refresh helper
async function refreshTokens(req) {
  const { refresh_token } = req.session.tokens;

  const response = await axios.post('https://zoom.us/oauth/token', null, {
    params: {
      grant_type: 'refresh_token',
      refresh_token
    },
    headers: {
      'Authorization': 'Basic ' + Buffer.from(
        `${process.env.ZOOM_APP_CLIENT_ID}:${process.env.ZOOM_APP_CLIENT_SECRET}`
      ).toString('base64')
    }
  });

  req.session.tokens = {
    access_token: response.data.access_token,
    refresh_token: response.data.refresh_token,
    expires_at: Date.now() + (response.data.expires_in * 1000)
  };

  return req.session.tokens;
}

module.exports = router;

Re-Authorization with promptAuthorize

For guest mode users who need to upgrade their authorization:

// Use when user needs to grant additional permissions
await zoomSdk.promptAuthorize();

// Same onAuthorized listener fires
zoomSdk.addEventListener('onAuthorized', async (event) => {
  // Handle same as initial authorization
});

Token Refresh Pattern

// Middleware to auto-refresh expired tokens
async function ensureAuthorized(req, res, next) {
  if (!req.session.tokens) {
    return res.status(401).json({ error: 'Not authorized' });
  }

  // Refresh if expiring within 5 minutes
  if (req.session.tokens.expires_at < Date.now() + 300000) {
    try {
      await refreshTokens(req);
    } catch (error) {
      return res.status(401).json({ error: 'Token refresh failed' });
    }
  }

  next();
}

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