Rivet SDK
OpenAIOfficialCreated by ZoomDistributed by OpenAI
- Skill
- Tool integration
- Software development
- MIT
- No issues found
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
Download the skill as a ZIP:
https://autogineer.com/agent-skills/openai/rivet-sdk/downloadUnzip 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
Confirm Rivet is the right abstraction for the integration’s REST, webhook, auth, and deployment needs.
Model the modules: app configuration, OAuth, API clients, webhook handlers, and business workflow handlers.
Implement the smallest authenticated API call and webhook receiver before composing multi-module flows.
Keep deployment constraints explicit, especially Lambda-style receivers and environment variable handling.
Debug by checking app credentials, token refresh, webhook signature handling, module wiring, and framework version drift.
References
Full preserved guide: references/full-guide.md
Rivet overview: rivet-sdk.md
Architecture and lifecycle: concepts/architecture-and-lifecycle.md
Getting started pattern: examples/getting-started-pattern.md
Multi-client pattern: examples/multi-client-pattern.md
Common issues: troubleshooting/common-issues.md
Files
- ATTRIBUTION.mdAdded by AutoGineer865 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.7 KiB
- SKILL.md1.3 KiB
- agents/openai.yaml132 B
- concepts/architecture-and-lifecycle.md3.3 KiB
- examples/getting-started-pattern.md1.3 KiB
- examples/multi-client-pattern.md1.7 KiB
- references/environment-variables.md2.2 KiB
- references/full-guide.md4.1 KiB
- references/rivet-reference-map.md1.1 KiB
- references/samples-validation.md1.7 KiB
- references/source-map.md893 B
- references/versioning-and-compatibility.md1.2 KiB
- rivet-sdk.md614 B
- scenarios/high-level-scenarios.md2.0 KiB
- troubleshooting/common-issues.md1.4 KiB
examples/getting-started-pattern.md
Getting Started Pattern (Single Module)
This pattern shows a minimal Rivet bootstrap for Team Chat with OAuth installation support.
import { TeamChatClient } from "@zoom/rivet/teamchat";
(async () => {
const teamchatClient = new TeamChatClient({
clientId: process.env.RIVET_CLIENT_ID,
clientSecret: process.env.RIVET_CLIENT_SECRET,
webhooksSecretToken: process.env.RIVET_WEBHOOK_SECRET_TOKEN,
installerOptions: {
redirectUri: process.env.RIVET_REDIRECT_URI,
stateStore: process.env.RIVET_STATE_STORE_SECRET,
},
port: Number(process.env.RIVET_PORT || 8080),
});
teamchatClient.webEventConsumer.event("chat_message.sent", ({ payload }) => {
console.log("event", payload);
});
const server = await teamchatClient.start();
console.log("rivet server", server.address());
})();Required Marketplace Wiring
Add endpoint URL to event subscription with
/zoom/eventssuffix.Ensure OAuth redirect URI exactly matches
installerOptions.redirectUri+ callback path behavior.Include all scopes needed by
endpoints.*calls.
Common Extension
Add API calls with typed wrappers:
const channels = await teamchatClient.endpoints.chatChannels.listUsersChannels({
path: { userId: "me" },
});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