AutoGineer
Generated banner for Rivet SDK
Generated logo for Rivet SDK

Rivet SDK

AnthropicOfficialCreated by ZoomDistributed by Anthropic

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

From the author

Reference skill for Zoom Rivet SDK. Use after routing to a Rivet-based server workflow when implementing auth handling, webhook consumers, API wrappers, multi-module composition, or Lambda receiver patterns.
— the description by Zoom

AutoGineer summary

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

The Zoom Rivet SDK is a server-side framework designed to streamline the development of Zoom integrations in JavaScript and TypeScript. It provides a structured approach to handling common integration tasks such as OAuth authentication, webhook event consumption, and interaction with Zoom REST APIs. By offering typed wrappers and modular composition, Rivet reduces the boilerplate code required to build robust Zoom-connected services, including chatbots, multi-module backends, and AWS Lambda-based webhook processors.

What it does

  • Provides typed wrappers for Zoom REST API endpoints.
  • Simplifies OAuth token management and authentication flows.
  • Offers standardized webhook receivers for event consumption.
  • Supports multi-module server composition within a single process.
  • Includes specialized receivers for AWS Lambda environments.
  • Facilitates event handling through dedicated processors and shortcuts.

When to use it

  • When building a Node.js server that requires Zoom authentication, webhooks, and API calls.
  • When you want to minimize glue code for Zoom integration scaffolding.
  • When developing multi-module applications that share a single backend process.
  • When implementing webhook processors for Zoom events.

Advantages

  • Reduces boilerplate through pre-built authentication and webhook handling.
  • Provides type-safe access to Zoom API operations.
  • Supports flexible deployment patterns including standard servers and AWS Lambda.
  • Enables modular architecture for complex integrations.

Usage examples

“How do I set up a basic webhook receiver using Rivet?”
The agent will guide you through instantiating a client, registering event handlers using the webEventConsumer, and configuring the webhook endpoint to receive events from Zoom.
“Can I use Rivet for a multi-module Zoom app?”
Yes, the agent will explain how to compose multiple modules (e.g., Chatbot, Meetings, Users) within a single process, including port configuration and client instantiation.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/anthropics/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

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.

Files

RUNBOOK.md

Rivet SDK 5-Minute Preflight Runbook

Use this before deep debugging.

Skill Doc Standard Note

  • Skill entrypoint is SKILL.md.

  • This runbook is an operational convention (recommended), not a required skill file.

  • SDK/API names can drift by version; validate names against changelog and TypeDoc before release.

1) Confirm Integration Surface

  • Confirm this is a server-side Node.js integration path using @zoom/rivet.

  • Confirm module boundaries (Chatbot, Team Chat, Meetings, Phone, Accounts, Users, Video SDK).

  • Confirm whether the app needs event receiver mode, API-only mode, or both.

2) Confirm Required Credentials

  • clientId, clientSecret for each module auth flow.

  • webhooksSecretToken for webhook verification (required for receiver flows).

  • accountId for S2S modules.

  • redirectUri and stateStore for User OAuth modules.

3) Confirm Lifecycle Order

  1. Instantiate module client(s) with auth/receiver options.

  2. Register webhook listeners before traffic.

  3. Start client server(s) and note per-module port(s).

  4. Expose /zoom/events for each active receiver endpoint.

  5. Execute API calls through client.endpoints.*.

4) Confirm Event/State Handling

  • Match event names exactly (bot_notification, interactive_message_fields_editable, etc.).

  • Keep module-specific webhook endpoints aligned with Marketplace subscription settings.

  • Persist OAuth tokens/state for long-lived integrations.

  • Keep idempotency in event handlers for retries/duplicates.

5) Confirm Cleanup + Upgrade Posture

  • Revalidate all module constructors and options on each upgrade.

  • Keep compatibility shims when module/type names change.

  • Review changelog version-by-version from current deployment to target.

6) Quick Probes

  • Client starts and binds to expected port(s).

  • Webhook verification succeeds for subscribed events.

  • One API call and one event callback complete successfully for each active module.

  • User OAuth install/callback flow works end-to-end when applicable.

7) Fast Decision Tree

  • API works but events fail -> wrong endpoint URL/port/path (/zoom/events) or bad webhook token.

  • OAuth install fails -> redirect URI/state store mismatch or unsupported receiver mode.

  • Multi-module collisions -> duplicate ports or shared env keys incorrectly mapped.

  • Lambda flow issues -> receiver type mismatch or missing webhooksSecretToken.

8) Source Checkpoints

Official docs
Raw docs in repo

  • tools/zoom-crawler/raw-docs/developers.zoom.us/docs/rivet/

  • tools/zoom-crawler/raw-docs/zoom.github.io/rivet-javascript/

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: Claude Code frontmatter

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
Anthropic (Official)
Distributed by
Anthropic
Source
anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/rivet-sdk · 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 rivet-sdk.zip