Skip to main content
command CX Codex GP ChatGPT official · OpenAI

build-zoom-rest-api-app — Codex command: what it does, how to install

Adds Zoom REST API endpoints to a project. It reviews auth requirements, plans the integration layer, and verifies requests without leaking secrets.

Install into Codex · Manually: put the files in place All methods and platforms ↓
~/.codex/prompts/build-zoom-rest-api-app.md
Open on GitHub

What build-zoom-rest-api-app does

This command guides the agent through adding Zoom REST endpoints for meetings and cloud recordings. It starts with a preflight check. The agent scans existing HTTP clients and environment variables. It also confirms that REST is the right choice rather than the Meeting SDK or webhooks.

Implementation follows an explicit plan. The agent determines required OAuth scopes and the files to touch. Code changes reuse existing HTTP clients and error handlers. Access tokens and secrets stay out of console logs. Once code is updated, it runs tests or performs a targeted API call to verify the request format.

Missing account scopes or absent callback URLs will halt live testing. When credentials are not yet configured, the workflow points developers to /setup-zoom-oauth.

What it helps with

  • add Zoom REST endpoints for meetings and users
  • verify OAuth token scopes before editing files
  • distinguish REST API tasks from SDK and webhook setups
  • validate API requests without printing tokens to logs

Example prompts for the agent

  • Integrate Zoom REST API endpoints to manage scheduled meetings
  • Connect Zoom user and recording endpoints to our backend service
  • Review project auth and implement Zoom account REST calls

How to install build-zoom-rest-api-app

Manually: put the files in place

~/.codex/prompts/build-zoom-rest-api-app.md

Call it with /prompts:build-zoom-rest-api-app. Codex marks this format deprecated in favour of skills

Questions about build-zoom-rest-api-app

How to install build-zoom-rest-api-app in Codex?

Place the command file at ~/.codex/prompts/build-zoom-rest-api-app.md. Codex will then recognize the prompt in your environment.

What does build-zoom-rest-api-app do?

It guides an AI coding agent to implement Zoom REST API endpoints, inspect existing wrappers, handle auth tokens, and run verification tests.

What happens if OAuth credentials are not set up?

The command reports missing scopes or permissions during preflight and suggests running /setup-zoom-oauth next.

Source text

build-zoom-rest-api-app.md · MIT
---
description: Implement a Zoom REST API integration with the right resources, auth path, and verification loop.
---

# Build Zoom REST API App

Use this command when the repo should call Zoom REST endpoints directly for meetings, users, recordings, docs-adjacent workflows, or account resources.

## Preflight

1. Inspect the codebase for existing Zoom API usage, env vars, HTTP client wrappers, and server routes.
2. Confirm the requested workflow is actually a REST API problem and not better served by Meeting SDK, Video SDK, or Webhooks.
3. Identify the runtime that will own the Zoom API calls and token lifecycle.
4. Check whether the required OAuth values and scope configuration already exist without printing secrets.

## Plan

Before making changes:

- state the exact Zoom resource or endpoint family to implement
- list the files that will be created or edited
- state the auth model, token owner, and required scopes
- state how the new API flow will be verified

## Commands

1. Inspect the existing project structure and add the Zoom API integration at the narrowest appropriate layer.
2. Reuse existing HTTP client, config, and error-handling patterns where possible.
3. Add or correct Zoom OAuth token usage, API calls, request validation, and response shaping.
4. Keep secrets out of logs and avoid leaking access tokens in output.
5. Add minimal docs or examples only where they materially help the next developer use the integration.

## Verification

1. Re-read the edited files and confirm the endpoint, auth path, and error handling are coherent.
2. Run the relevant local tests or build if available.
3. If safe credentials already exist, exercise the narrowest live or mocked API path to confirm request shape.
4. State any remaining blocker such as missing scopes, callback setup, or account permissions.

## Summary

```text
## Result
- Action: implemented or updated a Zoom REST API integration
- Status: success | partial | failed
- Details: endpoints, files changed, auth path, verification run
```

## Next Steps

- Run one end-to-end request with real credentials if not already done.
- Add webhook handoff only if the use case actually needs it.
- If auth is incomplete, run `/setup-zoom-oauth` next.

© Zoom · MIT · openai/plugins

Similar slash commands

All slash commands for Backend and APIs →

From the same set422

The whole set →
debug-zoom-auth Pins down which stage of Zoom sign-in is breaking: OAuth, SDK signature or token refresh. Useful when a login fails and the cause is unclear. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-virtual-agent Walks an agent through embedding Zoom Virtual Agent on web, Android or iOS: codebase recon, plan, edits, verification. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-team-chat-app A Claude and Claude command that walks the agent through building a Zoom Team Chat integration or chatbot: auth, eventing, message handling. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-rivet-app A slash command for Claude and Claude that scaffolds a server-side Zoom integration around the Rivet SDK: OAuth, API clients, webhooks and module wiring. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-probe-flow This command adds Zoom readiness checks before a meeting or session starts. Use it to gate entry on browser, device, and network diagnostics. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-phone-integration A Claude command that walks the agent through preflight, planning and verification while building a Zoom Phone integration: APIs, Smart Embed, calling flows, events. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-meeting-app This command builds an embedded or managed Zoom Meeting flow in the current codebase. Use it when the project needs Meeting SDK setup, authentication, and a join path. CX Codex GP ChatGPT ★ 7,596repo stars build-zoom-contact-center-app Walks the agent through recon, a written plan, scoped edits and verification when a repo needs Zoom Contact Center integration. CX Codex GP ChatGPT ★ 7,596repo stars

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor