AutoGineer
Generated banner for Rivet SDK
Generated logo for Rivet SDK

Rivet SDK

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Software development
  • MIT
  • No issues found
Download ZIP

From the author

Use when using Rivet SDK.
— the description by Zoom

AutoGineer summary

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

The Rivet SDK is a Node.js and TypeScript framework designed to simplify the development of Zoom integrations. It abstracts away the complexities of manual API and webhook plumbing by providing typed wrappers for Zoom REST APIs, standardized OAuth and token management, and structured webhook event consumption. It supports multi-module server composition, allowing developers to manage various Zoom services like Team Chat, Meetings, and Video SDK within a unified architecture.

What it does

  • Provides typed REST API endpoint wrappers for Zoom services.
  • Handles OAuth flow, token storage, and lifecycle management.
  • Simplifies webhook event consumption and signature verification.
  • Supports multi-module server architecture for complex integrations.
  • Offers specific modules for Chatbot, Team Chat, Meetings, and Video SDK.
  • Facilitates deployment via standardized environment variable configurations.

When to use it

  • When building a Node.js server-side integration for Zoom.
  • When you need to combine Zoom auth, webhooks, and API calls with minimal boilerplate.
  • When developing multi-module applications that require shared process management.
  • When implementing ISV orchestration layers with tenant-aware token storage.

Advantages

  • Reduces manual plumbing for authentication and webhook handling.
  • Provides a consistent, typed interface for Zoom API interactions.
  • Simplifies the management of multiple Zoom modules in a single backend.
  • Standardizes environment variable usage across different integration types.

Usage examples

“How do I set up a basic Rivet SDK project for a Zoom chatbot?”
The agent will guide you through instantiating the chatbot module, configuring the required environment variables like RIVET_CLIENT_ID and RIVET_WEBHOOK_SECRET_TOKEN, and registering event handlers.
“What environment variables are required for a multi-module Rivet integration?”
The agent will provide the list of core keys and port-specific keys, such as RIVET_CHATBOT_PORT and RIVET_MEETINGS_PORT, needed for your specific module configuration.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/openai/rivet-sdk/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip rivet-sdk.zip -d .agents/skills

Documentation by Zoom

Zoom Rivet SDK

Use this skill when building a server-side Zoom integration with Rivet rather than hand-rolled API and webhook plumbing.

Workflow

  1. Confirm Rivet is the right abstraction for the integration’s REST, webhook, auth, and deployment needs.

  2. Model the modules: app configuration, OAuth, API clients, webhook handlers, and business workflow handlers.

  3. Implement the smallest authenticated API call and webhook receiver before composing multi-module flows.

  4. Keep deployment constraints explicit, especially Lambda-style receivers and environment variable handling.

  5. Debug by checking app credentials, token refresh, webhook signature handling, module wiring, and framework version drift.

References

Files

references/full-guide.md

Zoom Rivet SDK

Background reference for Zoom Rivet as a JavaScript and TypeScript server framework for Zoom integrations.

Implementation guidance for Zoom Rivet (JavaScript/TypeScript) as a server-side framework for:

  • OAuth and token handling

  • Webhook event consumption

  • Typed REST API endpoint wrappers

  • Multi-module server composition

Official docs:

Reference samples:

Routing Guardrail

  • Rivet SDK is a Node.js framework that bundles Zoom auth handling, webhook receivers, and typed API wrappers.

  • Rivet is recommended for faster server-side scaffolding, but it is not mandatory.

  • At planning start, confirm preference:

  • Do you want Rivet SDK, or direct OAuth + REST without Rivet?

  • Use Rivet when the user wants a Node.js server that combines Zoom auth + webhooks + API calls with minimal glue code.

  • If the user only needs direct API calls from an existing backend, chain with ../rest-api/SKILL.md.

  • If the user is focused on Zoom Team Chat app cards/commands behavior, chain with ../team-chat/SKILL.md.

  • If the user needs SDK embed (Meeting SDK/Video SDK client runtime), route to ../meeting-sdk/SKILL.md or ../video-sdk/SKILL.md.

Quick Links

Start here:

  1. concepts/architecture-and-lifecycle.md

  2. scenarios/high-level-scenarios.md

  3. examples/getting-started-pattern.md

  4. examples/multi-client-pattern.md

  5. references/rivet-reference-map.md

  6. references/versioning-and-compatibility.md

  7. references/samples-validation.md

  8. references/source-map.md

  9. references/environment-variables.md

  10. troubleshooting/common-issues.md

  11. RUNBOOK.md

  12. rivet-sdk.md

Common Lifecycle Pattern

  1. Choose modules and auth model per module (Client Credentials, User OAuth, S2S OAuth, Video SDK JWT).

  2. Instantiate client(s) with credentials, webhook secret, and per-module port.

  3. Register event handlers (webEventConsumer.event(...) or shortcuts).

  4. Implement API calls through client.endpoints.*.

  5. Start receiver(s) and expose webhook endpoint(s) (/zoom/events) to Zoom.

  6. Persist tokens/state for OAuth workloads and enforce signature verification.

  7. Monitor module-specific failures and rotate secrets/version with changelog cadence.

High-Level Scenarios

  • Team Chat slash-command bot + Team Chat data API enrichment.

  • Multi-module backend (Users + Meetings + Team Chat + Phone) sharing one process.

  • Video SDK telemetry backend using videosdk module event stream + API surfaces.

  • ISV orchestration layer with tenant-aware token storage and per-module webhooks.

  • AWS Lambda webhook processor with Rivet AwsLambdaReceiver.

See scenarios/high-level-scenarios.md for details.

Chaining

  • OAuth architecture and grant selection: ../oauth/SKILL.md

  • API endpoint semantics and request payload details: ../rest-api/SKILL.md

  • Team Chat app cards, command and bot UX: ../team-chat/SKILL.md

  • Video SDK API-specific behavior and BYOS context: ../video-sdk/SKILL.md

Environment Variables

Operations

  • RUNBOOK.md - 5-minute preflight and debugging checklist.

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

No issues found by our static scan· No issues found

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/rivet-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 rivet-sdk.zip