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

concepts/architecture-and-lifecycle.md

Rivet Architecture and Lifecycle

What Rivet Provides

Rivet wraps three concerns into one module client:

  • Auth/token orchestration

  • Webhook receiver + event dispatch

  • Typed REST API endpoint wrappers

Architecture Model

+--------------------+        +------------------------------+
| Zoom Marketplace   |        | Your Rivet App               |
| App Config         |        | (Node.js/TypeScript)         |
+----------+---------+        +---------------+--------------+
           |                                  |
           | OAuth install / token exchange   |
           |--------------------------------->|
           |                                  |
           | Webhooks (POST /zoom/events)     |
           |--------------------------------->|
           |                                  v
           |                        +------------------------+
           |                        | Rivet Module Clients   |
           |                        | - ChatbotClient        |
           |                        | - TeamChatClient       |
           |                        | - Meetings*Client      |
           |                        | - Users*Client         |
           |                        | - Phone*Client         |
           |                        | - VideoSdkClient       |
           |                        +-----+------------+-----+
           |                              |            |
           |                              |            +--> webEventConsumer
           |                              |
           |                              +--> endpoints.* (REST wrappers)
           |                                           |
           |                                           v
           |                                  +------------------+
           +--------------------------------> | Zoom APIs        |
                                              +------------------+

Lifecycle Workflow

  1. Select module(s):

  • Example: ChatbotClient + TeamChatClient for bot + channel lookup.

  • Example: UsersS2SAuthClient + MeetingsS2SAuthClient for admin automation.

  1. Pick auth model by module:

  • Chatbot: Client Credentials

  • Team Chat/Meetings/Phone/Accounts/Users: User OAuth or S2S OAuth

  • Video SDK: JWT auth for Video SDK API

  1. Configure client options:

  • Required: clientId, clientSecret

  • Often required: webhooksSecretToken

  • Conditional: accountId, installerOptions, receiver, port, tokenStore

  1. Register listeners:

  • Generic: webEventConsumer.event("event_name", handler)

  • Shortcuts where available: onSlashCommand, onButtonClick, onChannelMessagePosted

  1. Start server(s):

  • await client.start() returns server handler/address

  • For multi-module apps, assign unique ports

  1. Wire Marketplace subscriptions:

  • Endpoint URL must target each module's receiver port

  • Endpoint path should include /zoom/events

  1. Process API + events:

  • API calls via client.endpoints.*

  • Event-driven actions via callback handlers

  1. Operate and upgrade:

  • Persist OAuth tokens/state for stable restarts

  • Use changelog + TypeDoc workflow for version upgrades

Why Multi-Client Port Strategy Matters

In sample patterns, each module runs its own receiver port. If multiple modules share one port by mistake, webhook routing and verification behavior can break in non-obvious ways.

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