Back to Details

rivet-sdk

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Zoom Rivet SDK

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:
作为适用于Zoom集成的JavaScript和TypeScript服务器框架，Zoom Rivet的背景参考资料。
针对Zoom Rivet（JavaScript/TypeScript）作为服务器端框架的实现指南，适用于：
  • OAuth与令牌处理
  • Webhook事件消费
  • 类型化REST API端点封装器
  • 多模块服务器组合
官方文档：
参考示例：

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.
  • Rivet SDK是一款Node.js框架，整合了Zoom认证处理、Webhook接收器和类型化API封装器。
  • 推荐使用Rivet来加快服务器端脚手架搭建，但并非强制要求。
  • 在规划初期，确认偏好：
  • 您希望使用Rivet SDK，还是不使用Rivet的直接OAuth + REST方案？
  • 当用户需要一个结合Zoom认证+Webhook+API调用且只需极少粘合代码的Node.js服务器时，使用Rivet。
  • 如果用户仅需要从现有后端直接调用API，请关联../rest-api/SKILL.md。
  • 如果用户专注于Zoom团队聊天应用卡片/命令行为，请关联../team-chat/SKILL.md。
  • 如果用户需要SDK嵌入（Meeting SDK/Video SDK客户端运行时），请转向../meeting-sdk/SKILL.md或../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
从以下内容开始：
  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.
  1. 根据每个模块选择模块和认证模型（客户端凭证、用户OAuth、S2S OAuth、Video SDK JWT）。
  2. 使用凭证、Webhook密钥和每个模块的端口实例化客户端。
  3. 注册事件处理器（
    webEventConsumer.event(...)
    或快捷方式）。
  4. 通过
    client.endpoints.*
    实现API调用。
  5. 启动接收器并向Zoom暴露Webhook端点（
    /zoom/events
    ）。
  6. 为OAuth工作负载持久化令牌/状态，并强制执行签名验证。
  7. 监控特定模块的故障，并按照变更日志节奏轮换密钥/版本。

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.
  • 团队聊天斜杠命令机器人 + 团队聊天数据API增强。
  • 多模块后端（用户 + 会议 + 团队聊天 + 电话）共享一个进程。
  • 使用
    videosdk
    模块事件流 + API接口的Video SDK遥测后端。
  • 具备租户感知令牌存储和按模块Webhook的ISV编排层。
  • 使用Rivet 
    AwsLambdaReceiver
    的AWS Lambda Webhook处理器。
详情请见scenarios/high-level-scenarios.md。

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
  • OAuth架构与授权类型选择：../oauth/SKILL.md
  • API端点语义与请求负载详情：../rest-api/SKILL.md
  • 团队聊天应用卡片、命令与机器人用户体验：../team-chat/SKILL.md
  • Video SDK特定API行为与BYOS上下文：../video-sdk/SKILL.md

Environment Variables

环境变量

  • See references/environment-variables.md for standardized 
    .env
    keys and where to find each value.
  • 标准化
    .env
    密钥及各值的获取位置，请见references/environment-variables.md。

Operations

运维

  • RUNBOOK.md - 5-minute preflight and debugging checklist.
  • RUNBOOK.md - 5分钟预检与调试清单。