Generated banner for Build Zoom Rest API App
Generated logo for Build Zoom Rest API App

Build Zoom Rest API App

AnthropicOfficialCreated by ZoomDistributed by Anthropic

  • Skill
  • Tool integration
  • Automation and integrations
  • MIT
  • Medium risk

From the author

Reference skill for Zoom REST API. Use after choosing an API-based workflow when you need endpoint selection, resource-management patterns, OAuth requirements, rate-limit awareness, or API error debugging.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill serves as a central hub for developers building server-side applications that interact with the Zoom platform. It provides structured guidance on API architecture, authentication flows, rate limiting, and endpoint discovery. By consolidating best practices, troubleshooting runbooks, and domain-specific references, it helps developers navigate the complexities of the Zoom REST API, including meeting management, user provisioning, and webhook integration.

What it does

  • Provides endpoint-level documentation for over 600 Zoom REST API operations.
  • Guides developers through Server-to-Server OAuth and other authentication flows.
  • Offers strategies for managing rate limits and per-user daily operation quotas.
  • Includes troubleshooting runbooks for common errors like 401 Unauthorized and 429 Too Many Requests.
  • Details architectural requirements such as regional base URLs and UUID double-encoding.
  • Provides examples for event-driven integrations using webhooks and CRC validation.

When to use it

  • When you need to select the correct API endpoint for a specific Zoom resource.
  • When implementing server-side automation for meetings, users, or recordings.
  • When debugging API errors or authentication failures in your integration.
  • When you need to understand rate-limiting strategies to ensure application stability.
  • When setting up a webhook server to receive real-time Zoom events.

Advantages

  • Centralizes documentation across 39 different API domains.
  • Provides clear, actionable guidance on deprecated vs. current authentication methods.
  • Includes specific runbooks for common production issues like rate-limit exhaustion.
  • Offers reliable patterns for complex tasks like meeting lifecycle management.
  • Maintains alignment with official Zoom API Hub endpoint inventories.

Usage examples

“How do I create a meeting using the Zoom REST API?”
The agent provides the correct POST endpoint, required headers, and a JSON payload example, while noting the need for S2S OAuth and specific host user ID formatting.
“I am getting a 429 error from the Zoom API. What should I do?”
The agent explains the shared account-level rate limits, suggests implementing backoff strategies, and points to the rate-limiting strategy documentation.
“How do I handle Zoom meeting UUIDs that contain slashes?”
The agent explains the requirement for double URL-encoding and provides a code snippet demonstrating how to properly encode the UUID.
“Can I use the 'me' keyword in my S2S OAuth app?”
The agent clarifies that 'me' is reserved for User OAuth apps and must not be used in S2S OAuth, providing the correct alternative of using a specific user ID.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/anthropics/build-zoom-rest-api-app/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip build-zoom-rest-api-app.zip -d .agents/skills

Documentation by Zoom

/build-zoom-rest-api-app

Background reference for deterministic server-side Zoom automation and resource management. Prefer plan-zoom-product, plan-zoom-integration, or debug-zoom first, then route here for endpoint-level detail.

Zoom REST API

Expert guidance for building server-side integrations with the Zoom REST API. This API provides 600+ endpoints for managing meetings, users, webinars, recordings, reports, and all Zoom platform resources programmatically.

Official Documentation: https://developers.zoom.us/api-hub/ API Hub Reference: https://developers.zoom.us/api-hub/meetings/ OpenAPI Inventories: https://developers.zoom.us/api-hub/<domain>/methods/endpoints.json

New to Zoom REST API? Follow this path:

  1. API Architecture - Base URLs, regional URLs, me keyword, ID vs UUID, time formats

  2. Authentication Flows - OAuth setup (S2S, User, PKCE, Device Code)

  3. Meeting URLs vs Meeting SDK - Stop mixing join_url with Meeting SDK

  4. Meeting Lifecycle - Create → Update → Start → End → Delete with webhooks

  5. Rate Limiting Strategy - Plan tiers, per-user limits, retry patterns

Reference:

  • Meetings - Meeting CRUD, types, settings

  • Users - User provisioning and management

  • Recordings - Cloud recording access and download

  • AI Services - Scribe endpoint inventory and current AI Services path surface

  • GraphQL Queries - Alternative query API (beta)

  • Integrated Index - see the section below in this file

Most domain files under references/ are aligned to the official API Hub endpoints.json inventories. Treat those files as the local source of truth for method/path discovery.

Having issues?

Building event-driven integrations?

Quick Start

Get an Access Token (Server-to-Server OAuth)
curl -X POST "https://zoom.us/oauth/token" \
  -H "Authorization: Basic $(echo -n 'CLIENT_ID:CLIENT_SECRET' | base64)" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=account_credentials&account_id=ACCOUNT_ID"

Response:

{
  "access_token": "eyJhbGciOiJIUzI1NiJ9...",
  "token_type": "bearer",
  "expires_in": 3600,
  "scope": "meeting:read meeting:write user:read"
}
Create a Meeting
curl -X POST "https://api.zoom.us/v2/users/HOST_USER_ID/meetings" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "Team Standup",
    "type": 2,
    "start_time": "2025-03-15T10:00:00Z",
    "duration": 30,
    "settings": {
      "join_before_host": false,
      "waiting_room": true
    }
  }'

For S2S OAuth, use an explicit host user ID or email in the path. Do not use me.

List Users with Pagination
curl "https://api.zoom.us/v2/users?page_size=300&status=active" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Base URL

https://api.zoom.us/v2
Regional Base URLs

The api_url field in OAuth token responses indicates the user's region. Use regional URLs for data residency compliance:

RegionURL
Global (default)https://api.zoom.us/v2
Australiahttps://api-au.zoom.us/v2
Canadahttps://api-ca.zoom.us/v2
European Unionhttps://api-eu.zoom.us/v2
Indiahttps://api-in.zoom.us/v2
Saudi Arabiahttps://api-sa.zoom.us/v2
Singaporehttps://api-sg.zoom.us/v2
United Kingdomhttps://api-uk.zoom.us/v2
United Stateshttps://api-us.zoom.us/v2

Note: You can always use the global URL https://api.zoom.us regardless of the api_url value.

Key Features

FeatureDescription
Meeting ManagementCreate, read, update, delete meetings with full scheduling control
User ProvisioningAutomated user lifecycle (create, update, deactivate, delete)
Webinar OperationsWebinar CRUD, registrant management, panelist control
Cloud RecordingsList, download, delete recordings with file-type filtering
Reports & AnalyticsUsage reports, participant data, daily statistics
Team ChatChannel management, messaging, chatbot integration
Zoom PhoneCall management, voicemail, call routing
Zoom RoomsRoom management, device control, scheduling
WebhooksReal-time event notifications for 100+ event types
WebSocketsPersistent event streaming without public endpoints
GraphQL (Beta)Single-endpoint flexible queries at v3/graphql
AI CompanionMeeting summaries, transcripts, AI-generated content
AI Services / ScribeFile and archive transcription via Build-platform JWT-authenticated endpoints

Prerequisites

  • Zoom account (Free tier has API access with lower rate limits)

  • App registered on Zoom App Marketplace

  • OAuth credentials (Server-to-Server OAuth or User OAuth)

  • Appropriate scopes for target endpoints

Need help with authentication? See the zoom-oauth skill for complete OAuth flow implementation.

Critical Gotchas and Best Practices

⚠️ JWT App Type is Deprecated

The JWT app type is deprecated. Migrate to Server-to-Server OAuth. This does NOT affect JWT token signatures used in Video SDK — only the Marketplace "JWT" app type for REST API access.

// OLD (JWT app type - DEPRECATED)
const token = jwt.sign({ iss: apiKey, exp: expiry }, apiSecret);

// NEW (Server-to-Server OAuth)
const token = await getServerToServerToken(accountId, clientId, clientSecret);
⚠️ The me Keyword Rules
  • User-level OAuth apps: MUST use me instead of userId (otherwise: invalid token error)

  • Server-to-Server OAuth apps: MUST NOT use me — provide the actual userId or email

  • Account-level OAuth apps: Can use either me or userId

⚠️ Meeting ID vs UUID — Double Encoding

UUIDs that begin with / or contain // must be double URL-encoded:

// UUID: /abc==
// Single encode: %2Fabc%3D%3D
// Double encode: %252Fabc%253D%253D  ← USE THIS

const uuid = '/abc==';
const encoded = encodeURIComponent(encodeURIComponent(uuid));
const url = `https://api.zoom.us/v2/meetings/${encoded}`;
⚠️ Time Formats
  • yyyy-MM-ddTHH:mm:ssZ — UTC time (note the Z suffix)

  • yyyy-MM-ddTHH:mm:ss — Local time (no Z, uses timezone field)

  • Some report APIs only accept UTC. Check the API reference for each endpoint.

⚠️ Rate Limits Are Per-Account, Not Per-App

All apps on the same Zoom account share rate limits. One heavy app can impact others. Monitor X-RateLimit-Remaining headers proactively.

⚠️ Per-User Daily Limits

Meeting/Webinar create/update operations are limited to 100 per day per user (resets at 00:00 UTC). Distribute operations across different host users when doing bulk operations.

⚠️ Download URLs Require Auth and Follow Redirects

Recording download_url values require Bearer token authentication and may redirect. Always follow redirects:

curl -L -H "Authorization: Bearer ACCESS_TOKEN" "https://zoom.us/rec/download/..."
Use Webhooks Instead of Polling
// DON'T: Poll every minute (wastes API quota)
setInterval(() => getMeetings(), 60000);

// DO: Receive webhook events in real-time
app.post('/webhook', (req, res) => {
  if (req.body.event === 'meeting.started') {
    handleMeetingStarted(req.body.payload);
  }
  res.status(200).send();
});

Webhook setup details: See the zoom-webhooks skill for comprehensive webhook implementation.

Complete Documentation Library

This skill includes comprehensive guides organized by category:

Core Concepts
Complete Examples
Troubleshooting
  • Common Errors - HTTP status codes, Zoom error codes, error response formats

  • Common Issues - Rate limits, token refresh, pagination pitfalls, gotchas

References (39 files covering all Zoom API domains)
Core APIs
Communication
Infrastructure
Advanced
Additional API Domains

Sample Repositories

Official (by Zoom)

Resources


Need help? Start with Integrated Index section below for complete navigation.


Integrated Index

This section was migrated from SKILL.md.

Quick Start Path

If you're new to the Zoom REST API, follow this order:

  1. Run preflight checks first → RUNBOOK.md

  2. Understand the API design → concepts/api-architecture.md

    • Base URLs, regional endpoints, me keyword rules

    • Meeting ID vs UUID, double-encoding, time formats

  3. Set up authentication → concepts/authentication-flows.md

    • Server-to-Server OAuth (backend automation)

    • User OAuth with PKCE (user-facing apps)

    • Cross-reference: zoom-oauth

  4. Create your first meeting → examples/meeting-lifecycle.md

    • Full CRUD with curl and Node.js examples

    • Webhook event integration

  5. Handle rate limits → concepts/rate-limiting-strategy.md

    • Plan-based limits, retry patterns, request queuing

  6. Set up webhooks → examples/webhook-server.md

    • CRC validation, signature verification, event handling

  7. Troubleshoot issues → troubleshooting/common-issues.md

    • Token refresh, pagination pitfalls, common gotchas


Documentation Structure

rest-api/
├── SKILL.md                              # Main skill overview + quick start
├── SKILL.md                              # This file - navigation guide
│
├── concepts/                             # Core architectural concepts
│   ├── api-architecture.md              # REST design, URLs, IDs, time formats
│   ├── authentication-flows.md          # OAuth flows (S2S, User, PKCE, Device)
│   └── rate-limiting-strategy.md        # Limits by plan, retry, queuing
│
├── examples/                             # Complete working code
│   ├── meeting-lifecycle.md             # Create→Update→Start→End→Delete
│   ├── user-management.md              # CRUD users, pagination, bulk ops
│   ├── recording-pipeline.md           # Download recordings via webhooks
│   ├── webhook-server.md               # Express.js CRC + signature verification
│   └── graphql-queries.md              # GraphQL queries, mutations, pagination
│
├── troubleshooting/                      # Problem solving
│   ├── common-errors.md                # HTTP codes, Zoom error codes table
│   └── common-issues.md               # Rate limits, tokens, pagination pitfalls
│
└── references/                           # 39 domain-specific reference files
    ├── authentication.md                # Auth methods reference
    ├── meetings.md                      # Meeting endpoints
    ├── users.md                         # User management endpoints
    ├── webinars.md                      # Webinar endpoints
    ├── recordings.md                    # Cloud recording endpoints
    ├── reports.md                       # Reports & analytics
    ├── accounts.md                      # Account management
    ├── rate-limits.md                   # Rate limit details
    ├── graphql.md                       # GraphQL API (beta)
    ├── zoom-team-chat.md                     # Team Chat messaging
    ├── chatbot.md                       # Chatbot integration
    ├── phone.md                         # Zoom Phone
    ├── rooms.md                         # Zoom Rooms
    ├── calendar.md                      # Zoom Calendar
    ├── mail.md                          # Zoom Mail
    ├── ai-companion.md                  # AI features
    ├── openapi.md                       # OpenAPI specs
    ├── qss.md                           # Quality of Service
    ├── contact-center.md                # Contact Center
    ├── events.md                        # Zoom Events
    ├── whiteboard.md                    # Whiteboard
    ├── clips.md                         # Zoom Clips
    ├── scheduler.md                     # Scheduler
    ├── scim2.md                         # SCIM 2.0
    ├── marketplace-apps.md              # App management
    ├── zoom-video-sdk-api.md                 # Video SDK REST
    └── ... (39 total files)

By Use Case

I want to create and manage meetings
  1. API Architecture - Base URL, time formats

  2. Meeting Lifecycle - Full CRUD + webhook events

  3. Meetings Reference - All endpoints, types, settings

I want to manage users programmatically
  1. User Management - CRUD, pagination, bulk ops

  2. Users Reference - Endpoints, user types, scopes

I want to download recordings automatically
  1. Recording Pipeline - Webhook-triggered downloads

  2. Recordings Reference - File types, download auth

I want to receive real-time events
  1. Webhook Server - CRC validation, signature check

  2. Cross-reference: zoom-webhooks for comprehensive webhook docs

  3. Cross-reference: zoom-websockets for WebSocket events

I want to use GraphQL instead of REST
  1. GraphQL Queries - Queries, mutations, pagination

  2. GraphQL Reference - Available entities, scopes, rate limits

I want to set up authentication
  1. Authentication Flows - All OAuth methods

  2. Cross-reference: zoom-oauth for full OAuth implementation

I'm hitting rate limits
  1. Rate Limiting Strategy - Limits by plan, strategies

  2. Rate Limits Reference - Detailed tables

  3. Common Issues - Practical solutions

I'm getting errors
  1. Common Errors - Error code tables

  2. Common Issues - Diagnostic workflow

I want to build webinars
  1. Webinars Reference - Endpoints, types, registrants

  2. Meeting Lifecycle - Similar patterns apply

I want to integrate Zoom Phone
  1. Phone Reference - Phone API endpoints

  2. Rate Limiting Strategy - Separate Phone rate limits


Most Critical Documents

1. API Architecture (FOUNDATION)

concepts/api-architecture.md

Essential knowledge before making any API call:

  • Base URLs and regional endpoints

  • The me keyword rules (different per app type!)

  • Meeting ID vs UUID double-encoding

  • ISO 8601 time formats (UTC vs local)

  • Download URL authentication

2. Rate Limiting Strategy (MOST COMMON PRODUCTION ISSUE)

concepts/rate-limiting-strategy.md

Rate limits are per-account, shared across all apps:

  • Free: 4/sec Light, 2/sec Medium, 1/sec Heavy

  • Pro: 30/sec Light, 20/sec Medium, 10/sec Heavy

  • Business+: 80/sec Light, 60/sec Medium, 40/sec Heavy

  • Per-user: 100 meeting create/update per day

3. Meeting Lifecycle (MOST COMMON TASK)

examples/meeting-lifecycle.md

Complete CRUD with webhook integration — the pattern most developers need first.


Key Learnings

Critical Discoveries:
  1. JWT app type is deprecated — use Server-to-Server OAuth

  2. me keyword behaves differently by app type

  3. Rate limiting is nuanced (don’t assume a single global rule)

    • Limits can vary by endpoint and may be enforced at account/app/user levels

    • Treat quotas as potentially shared across your account and implement backoff

    • Monitor rate limit response headers (for example X-RateLimit-Remaining)

    • See: Rate Limiting Strategy

  4. 100 meeting creates per user per day

    • This is a hard per-user limit, not related to rate limits

    • Distribute across host users for bulk operations

    • See: Rate Limiting Strategy

  5. UUID double-encoding is required for certain UUIDs

    • UUIDs starting with / or containing // must be double-encoded

    • See: API Architecture

  6. Pagination: use next_page_token, not page_number

    • page_number is legacy and being phased out

    • next_page_token is the recommended approach

    • See: Common Issues

  7. GraphQL is at /v3/graphql, not /v2/

    • Single endpoint, cursor-based pagination

    • Rate limits apply per-field (each field = one REST equivalent)

    • See: GraphQL Queries


Quick Reference

"401 Unauthorized"

→ Authentication Flows - Token expired or wrong scopes

"429 Too Many Requests"

→ Rate Limiting Strategy - Check headers for reset time

"Invalid token" when using userId

→ API Architecture - User OAuth apps must use me

"How do I paginate results?"

→ Common Issues - Use next_page_token

"Webhooks not arriving"

→ Webhook Server - CRC validation required

"Recording download fails"

→ Recording Pipeline - Bearer auth + follow redirects

"How do I create a meeting?"

→ Meeting Lifecycle - Full working examples


SkillUse When
zoom-oauthImplementing OAuth flows, token management
zoom-webhooksDeep webhook implementation, event catalog
zoom-websocketsWebSocket event streaming
zoom-generalCross-product patterns, community repos

Based on Zoom REST API v2 (current) and GraphQL v3 (beta)

Environment Variables

Files

examples/webhook-server.md

Webhook Server - Express.js with CRC Validation and Signature Verification

Production-ready webhook server implementation for receiving Zoom webhook events with CRC (Challenge-Response Check) validation and HMAC signature verification.

For comprehensive webhook documentation, see the webhooks skill.

Quick Start

1. Install Dependencies
npm install express body-parser crypto
2. Basic Webhook Server
const express = require('express');
const crypto = require('crypto');
const app = express();

// Zoom webhook secret token (from your app's Feature page)
const WEBHOOK_SECRET_TOKEN = process.env.ZOOM_WEBHOOK_SECRET;

// Parse JSON bodies
app.use(express.json());

// Webhook endpoint
app.post('/webhook', (req, res) => {
  const { event, payload } = req.body;

  // Handle CRC validation (Challenge-Response Check)
  if (event === 'endpoint.url_validation') {
    return handleCRC(req, res);
  }

  // Verify signature
  if (!verifySignature(req)) {
    console.error('Invalid signature');
    return res.status(401).send('Unauthorized');
  }

  // Handle events
  handleEvent(event, payload);

  // Always respond with 200 within 3 seconds
  res.status(200).send();
});

app.listen(3000, () => {
  console.log('Webhook server running on port 3000');
});

CRC (Challenge-Response Check) Validation

When you add a webhook URL or make changes, Zoom sends a validation request. You must respond within 3 seconds.

CRC Flow
  1. Zoom sends POST with event: "endpoint.url_validation"

  2. Your server hashes the plainToken using your webhook secret

  3. Respond with JSON containing both plainToken and encryptedToken

Implementation
function handleCRC(req, res) {
  const { plainToken } = req.body.payload;

  // Hash the plainToken with HMAC-SHA256
  const encryptedToken = crypto
    .createHmac('sha256', WEBHOOK_SECRET_TOKEN)
    .update(plainToken)
    .digest('hex');

  // Respond within 3 seconds
  res.status(200).json({
    plainToken,
    encryptedToken
  });

  console.log('CRC validation successful');
}
CRC Request Example
{
  "event": "endpoint.url_validation",
  "payload": {
    "plainToken": "qgg8vlvZRS6UYooatFL8Aw"
  },
  "event_ts": 1654503849680
}
CRC Response Example
{
  "plainToken": "qgg8vlvZRS6UYooatFL8Aw",
  "encryptedToken": "23a89b634c017e5364a1c8d9c8ea909b60dd5599e2bb04bb1558d9c3a121faa5"
}

Signature Verification

Verify that webhook requests actually come from Zoom by checking the HMAC signature.

Signature Verification Flow
  1. Extract x-zm-signature and x-zm-request-timestamp headers

  2. Construct message: v0:{timestamp}:{body}

  3. Hash message with HMAC-SHA256 using your webhook secret

  4. Prepend v0= to the hash

  5. Compare with x-zm-signature header

Implementation
function verifySignature(req) {
  const signature = req.headers['x-zm-signature'];
  const timestamp = req.headers['x-zm-request-timestamp'];

  if (!signature || !timestamp) {
    console.error('Missing signature headers');
    return false;
  }

  // Construct the message
  const message = `v0:${timestamp}:${JSON.stringify(req.body)}`;

  // Hash the message
  const hashForVerify = crypto
    .createHmac('sha256', WEBHOOK_SECRET_TOKEN)
    .update(message)
    .digest('hex');

  // Prepend v0=
  const computedSignature = `v0=${hashForVerify}`;

  // Compare signatures
  return signature === computedSignature;
}
Signature Headers Example
POST /webhook HTTP/1.1
Host: example.com
x-zm-signature: v0=a05d830fa017433bc47887f835a00b9ff33d3882f22f63a2986a8es270341
x-zm-request-timestamp: 1658940994
Content-Type: application/json

{"event":"meeting.started","payload":{...}}

Event Handling

Event Router
function handleEvent(event, payload) {
  switch (event) {
    case 'meeting.created':
      handleMeetingCreated(payload);
      break;

    case 'meeting.started':
      handleMeetingStarted(payload);
      break;

    case 'meeting.ended':
      handleMeetingEnded(payload);
      break;

    case 'meeting.participant_joined':
      handleParticipantJoined(payload);
      break;

    case 'recording.completed':
      handleRecordingCompleted(payload);
      break;

    default:
      console.log(`Unhandled event: ${event}`);
  }
}
Event Handlers
function handleMeetingStarted(payload) {
  const { id, uuid, topic, start_time } = payload.object;
  console.log(`Meeting started: ${topic} (ID: ${id})`);
  
  // Your logic: Send notifications, start recording, etc.
  // Example: Trigger auto-recording
  // await startCloudRecording(id);
}

function handleMeetingEnded(payload) {
  const { id, uuid, topic, duration } = payload.object;
  console.log(`Meeting ended: ${topic} (Duration: ${duration}min)`);
  
  // Your logic: Process analytics, trigger workflows, etc.
}

function handleRecordingCompleted(payload) {
  const { id, uuid, topic, recording_files } = payload.object;
  console.log(`Recording ready: ${topic}`);
  
  // Download recordings (see recording-pipeline.md)
  recording_files.forEach(file => {
    console.log(`- ${file.file_type}: ${file.download_url}`);
    // downloadRecording(file.download_url, file.id);
  });
}

function handleParticipantJoined(payload) {
  const { participant } = payload.object;
  console.log(`Participant joined: ${participant.user_name}`);
  
  // Your logic: Track attendance, send welcome message, etc.
}

Complete Production Server

const express = require('express');
const crypto = require('crypto');
const app = express();

const WEBHOOK_SECRET_TOKEN = process.env.ZOOM_WEBHOOK_SECRET;
const PORT = process.env.PORT || 3000;

// Middleware
app.use(express.json());

// Request logging
app.use((req, res, next) => {
  console.log(`${new Date().toISOString()} - ${req.method} ${req.path}`);
  next();
});

// Webhook endpoint
app.post('/webhook', async (req, res) => {
  try {
    const { event, payload, event_ts } = req.body;

    // CRC validation
    if (event === 'endpoint.url_validation') {
      return handleCRC(req, res);
    }

    // Verify signature
    if (!verifySignature(req)) {
      console.error('Signature verification failed');
      return res.status(401).send('Unauthorized');
    }

    // Log event
    console.log(`Event received: ${event} at ${new Date(event_ts)}`);

    // Handle event asynchronously
    setImmediate(() => {
      handleEvent(event, payload).catch(error => {
        console.error('Error handling event:', error);
      });
    });

    // Respond immediately (within 3 seconds)
    res.status(200).send();

  } catch (error) {
    console.error('Webhook error:', error);
    res.status(500).send('Internal Server Error');
  }
});

// CRC validation
function handleCRC(req, res) {
  const { plainToken } = req.body.payload;

  const encryptedToken = crypto
    .createHmac('sha256', WEBHOOK_SECRET_TOKEN)
    .update(plainToken)
    .digest('hex');

  res.status(200).json({ plainToken, encryptedToken });
  console.log('CRC validation successful');
}

// Signature verification
function verifySignature(req) {
  const signature = req.headers['x-zm-signature'];
  const timestamp = req.headers['x-zm-request-timestamp'];

  if (!signature || !timestamp) {
    return false;
  }

  const message = `v0:${timestamp}:${JSON.stringify(req.body)}`;

  const hashForVerify = crypto
    .createHmac('sha256', WEBHOOK_SECRET_TOKEN)
    .update(message)
    .digest('hex');

  const computedSignature = `v0=${hashForVerify}`;

  return signature === computedSignature;
}

// Event handler
async function handleEvent(event, payload) {
  switch (event) {
    case 'meeting.started':
      await handleMeetingStarted(payload);
      break;

    case 'meeting.ended':
      await handleMeetingEnded(payload);
      break;

    case 'recording.completed':
      await handleRecordingCompleted(payload);
      break;

    // Add more event handlers as needed
    default:
      console.log(`Unhandled event: ${event}`);
  }
}

async function handleMeetingStarted(payload) {
  console.log(`Meeting started: ${payload.object.topic}`);
  // Your business logic
}

async function handleMeetingEnded(payload) {
  console.log(`Meeting ended: ${payload.object.topic}`);
  // Your business logic
}

async function handleRecordingCompleted(payload) {
  console.log(`Recording completed: ${payload.object.topic}`);
  // Download logic (see recording-pipeline.md)
}

// Health check
app.get('/health', (req, res) => {
  res.status(200).json({ status: 'ok', timestamp: new Date().toISOString() });
});

// Start server
app.listen(PORT, () => {
  console.log(`Webhook server running on port ${PORT}`);
  console.log(`Webhook endpoint: ${process.env.PUBLIC_BASE_URL || 'https://YOUR_PUBLIC_BASE_URL'}/webhook`);
});

// Graceful shutdown
process.on('SIGTERM', () => {
  console.log('SIGTERM received, shutting down gracefully');
  process.exit(0);
});

Webhook Retry Policy

Zoom automatically retries failed webhooks 3 times with exponential backoff:

  1. First retry: 5 minutes after initial failure

  2. Second retry: 20 minutes after first retry

  3. Third retry: 60 minutes after second retry

Retry Conditions

Zoom retries for:

  • HTTP status codes ≥ 500

  • Network errors (connection refused, timeout, etc.)

Zoom does NOT retry for:

  • HTTP status codes 200-299 (success)

  • HTTP status codes 300-399 (redirects)

  • HTTP status codes 400-499 (client errors)

Handling Retries
// Track processed events to avoid duplicate processing
const processedEvents = new Set();

app.post('/webhook', (req, res) => {
  const { event, event_ts, payload } = req.body;

  // Create unique event ID
  const eventId = `${event}-${event_ts}-${payload.object?.id || ''}`;

  // Check if already processed (duplicate due to retry)
  if (processedEvents.has(eventId)) {
    console.log(`Duplicate event: ${eventId}`);
    return res.status(200).send();  // Still return 200
  }

  // Mark as processed
  processedEvents.add(eventId);

  // Handle event
  handleEvent(event, payload);

  res.status(200).send();

  // Clean up old entries after 2 hours
  setTimeout(() => processedEvents.delete(eventId), 2 * 60 * 60 * 1000);
});

Webhook Revalidation

Zoom automatically revalidates webhook endpoints every 72 hours. If revalidation fails 6 consecutive times, Zoom disables the webhook.

Revalidation Notifications
  • 2 failures: First email notification

  • 4 failures: Second email notification

  • 6 failures: Webhook disabled

Ensure Uptime
// Health check with monitoring
app.get('/health', (req, res) => {
  // Check dependencies (database, external APIs, etc.)
  const isHealthy = checkDependencies();

  if (isHealthy) {
    res.status(200).json({
      status: 'ok',
      timestamp: new Date().toISOString(),
      uptime: process.uptime()
    });
  } else {
    res.status(503).json({
      status: 'unhealthy',
      timestamp: new Date().toISOString()
    });
  }
});

function checkDependencies() {
  // Check database connection, external APIs, etc.
  return true;
}

Environment Variables

# .env
ZOOM_WEBHOOK_SECRET=your_webhook_secret_token_here
PORT=3000
NODE_ENV=production
Loading Environment Variables
require('dotenv').config();

const WEBHOOK_SECRET_TOKEN = process.env.ZOOM_WEBHOOK_SECRET;

if (!WEBHOOK_SECRET_TOKEN) {
  throw new Error('ZOOM_WEBHOOK_SECRET environment variable is required');
}

Deployment

Requirements
  1. HTTPS required - Zoom only sends to HTTPS endpoints

  2. Public URL - Endpoint must be publicly accessible

  3. TLS 1.2+ - Valid certificate from a Certificate Authority (CA)

  4. FQDN - Fully qualified domain name (not IP address)

  5. Response time - Respond within 3 seconds

Deployment Options
  • Heroku: git push heroku main

  • AWS Lambda: Use API Gateway + Lambda function

  • Vercel/Netlify: Serverless functions

  • Self-hosted: Nginx + Node.js + Let's Encrypt

ngrok for Local Development
# Install ngrok
npm install -g ngrok

# Start your server
node server.js

# In another terminal, expose to public URL
ngrok http 3000

# Use the HTTPS URL in Zoom webhook configuration
# Example: https://abc123.ngrok.io/webhook

Testing

Test CRC Validation
WEBHOOK_BASE_URL="http://YOUR_DEV_HOST:3000"

curl -X POST "$WEBHOOK_BASE_URL/webhook" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "endpoint.url_validation",
    "payload": {
      "plainToken": "test_token_123"
    },
    "event_ts": 1654503849680
  }'

Expected response:

{
  "plainToken": "test_token_123",
  "encryptedToken": "..."
}
Test Event Handling
# Generate valid signature
TIMESTAMP=$(date +%s)
MESSAGE="v0:${TIMESTAMP}:{\"event\":\"meeting.started\",\"payload\":{\"object\":{\"id\":\"123\",\"topic\":\"Test\"}}}"
SIGNATURE="v0=$(echo -n "$MESSAGE" | openssl dgst -sha256 -hmac "YOUR_SECRET" -binary | xxd -p)"

WEBHOOK_BASE_URL="http://YOUR_DEV_HOST:3000"

curl -X POST "$WEBHOOK_BASE_URL/webhook" \
  -H "Content-Type: application/json" \
  -H "x-zm-signature: $SIGNATURE" \
  -H "x-zm-request-timestamp: $TIMESTAMP" \
  -d '{"event":"meeting.started","payload":{"object":{"id":"123","topic":"Test Meeting"}}}'

Common Event Types

EventDescription
meeting.createdMeeting created
meeting.updatedMeeting details changed
meeting.deletedMeeting deleted
meeting.startedMeeting begins
meeting.endedMeeting ends
meeting.participant_joinedParticipant joins
meeting.participant_leftParticipant leaves
recording.completedCloud recording ready
recording.transcript_completedTranscript ready
user.createdUser created
user.updatedUser updated
user.deletedUser deleted

See complete event catalog: webhooks skill

Resources

Requirements and compatibility

Written for: Claude Code, Claude apps

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.

Needs: Needs network access, Needs Python, Needs Node.js

Security

What our scanner noticed· Medium risk

  • Possible data-exfiltration endpoints
  • Instructions that use the network

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
Anthropic (Official)
Distributed by
Anthropic
Source
anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/rest-api · commit e050c2e
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from partner-built/zoom-plugin/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or Anthropic.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download build-zoom-rest-api-app.zip