关于 rivet-sdk
面向开发者的 Zoom Rivet 参考技能,介绍用于 Zoom 集成的 JavaScript 和 TypeScript 服务端框架,涵盖认证、Webhook、类型化 API 调用和多模块服务组合。
主要功能
- 01OAuth 与令牌处理指南
- 02Webhook 事件接收模式
- 03类型化 REST 端点封装
- 04多模块服务组合
- 05生命周期与运维参考
适用场景
- 01搭建含 Zoom 认证和 API 调用的 Node.js 服务
- 02处理 Zoom Webhook 事件
- 03在一个后端组合多个 Zoom 模块
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ anthropics/ knowledge-work-plugins --skill rivet-sdk安装后在 Claude Code 中输入/rivet-sdk确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rivet-sdk.mdRUNBOOK.mdconcepts/architecture-and-lifecycle.mdexamples/getting-started-pattern.mdmulti-client-pattern.mdreferences/environment-variables.mdrivet-reference-map.mdsamples-validation.mdsource-map.mdversioning-and-compatibility.mdscenarios/high-level-scenarios.mdtroubleshooting/common-issues.md详细介绍
Zoom Rivet SDK
Zoom Rivet 作为面向 Zoom 集成的 JavaScript 和 TypeScript 服务端框架的背景参考。
Zoom Rivet(JavaScript/TypeScript)作为服务端框架的实现指导,涵盖以下方面:
- OAuth 与令牌处理
- Webhook 事件消费
- 带类型的 REST API 端点封装
- 多模块服务端组合
官方文档:
- https://developers.zoom.us/docs/rivet/
- https://developers.zoom.us/docs/rivet/javascript/
- https://zoom.github.io/rivet-javascript/
参考示例:
- https://github.com/zoom/rivet-javascript-sample
- https://github.com/zoom/isv-rivet-starter
- https://github.com/zoom/Rivet-Server-Sample
- https://github.com/zoom/rivet-javascript
路由守则
- Rivet SDK 是一个 Node.js 框架,集成了 Zoom 认证处理、Webhook 接收器和带类型的 API 封装。
- 推荐使用 Rivet 以加快服务端脚手架搭建,但并非必需。
- 规划开始时,确认偏好:
您想使用 Rivet SDK,还是直接使用 OAuth + REST 而不使用 Rivet?- 当用户需要一个 Node.js 服务端,以最少的胶水代码整合 Zoom 认证、Webhook 和 API 调用时,使用 Rivet。
- 如果用户只需要从现有后端直接调用 API,请衔接 ../rest-api/SKILL.md。
- 如果用户关注 Zoom Team Chat 应用卡片/命令的行为,请衔接 ../team-chat/SKILL.md。
- 如果用户需要 SDK 嵌入(Meeting SDK/Video SDK 客户端运行时),请转至 ../meeting-sdk/SKILL.md 或 ../video-sdk/SKILL.md。
快速链接
从这里开始:
- concepts/architecture-and-lifecycle.md
- scenarios/high-level-scenarios.md
- examples/getting-started-pattern.md
- examples/multi-client-pattern.md
- references/rivet-reference-map.md
- references/versioning-and-compatibility.md
- references/samples-validation.md
- references/source-map.md
- references/environment-variables.md
- troubleshooting/common-issues.md
- RUNBOOK.md
- rivet-sdk.md
通用生命周期模式
- 为每个模块选择模块和认证模式(Client Credentials、User OAuth、S2S OAuth、Video SDK JWT)。
- 使用凭据、Webhook 密钥和各模块端口实例化客户端。
- 注册事件处理器(
webEventConsumer.event(...)或快捷方式)。 - 通过
client.endpoints.*实现 API 调用。 - 启动接收器,并向 Zoom 暴露 Webhook 端点(
/zoom/events)。 - 为 OAuth 工作负载持久化令牌/状态,并强制执行签名验证。
- 监控特定模块的故障,并按照更新日志的节奏轮换密钥/版本。
高层场景
- Team Chat 斜杠命令机器人 + Team Chat 数据 API 数据增强。
- 在同一进程中共享的多模块后端(Users + Meetings + Team Chat + Phone)。
- 使用
videosdk模块事件流和 API 接口的 Video SDK 遥测后端。 - 具备租户感知令牌存储和按模块 Webhook 的 ISV 编排层。
- 使用 Rivet
AwsLambdaReceiver的 AWS Lambda Webhook 处理器。
详情请参阅 scenarios/high-level-scenarios.md。
衔接
- OAuth 架构与授权类型选择:../oauth/SKILL.md
- API 端点语义与请求负载细节:../rest-api/SKILL.md
- Team Chat 应用卡片、命令与机器人交互:../team-chat/SKILL.md
- Video SDK API 特定行为与 BYOS 上下文:../video-sdk/SKILL.md
环境变量
- 标准化
.env键名及各值的获取位置,请参阅 references/environment-variables.md。
运维
- RUNBOOK.md - 5 分钟预检与调试清单。
评论
支持 Markdown