Zoom Rivet SDK

Zoom Rivet を 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 は Zoom 認証処理、webhook レシーバー、型付き API ラッパーをバンドルした Node.js フレームワークです。
• Rivet はサーバーサイドスキャフォルディングを高速化するために推奨されていますが、必須ではありません。
• 計画開始時に、以下を確認してください:
• Rivet SDK を使用したいですか、それとも直接 OAuth + REST を使用しますか?
• ユーザーが Zoom 認証 + webhooks + API 呼び出しをグルーコード最小限で組み合わせた Node.js サーバーを望む場合、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 にルーティングしてください。

クイックリンク

ここから始めてください:

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. モジュールごとにモジュールと認証モデルを選択 (Client Credentials、User OAuth、S2S OAuth、Video SDK JWT)。
2. 認証情報、webhook シークレット、モジュールごとのポートでクライアント(s) をインスタンス化。
3. イベントハンドラーを登録 (webEventConsumer.event(...) またはショートカット)。
4. client.endpoints.* を通じて API 呼び出しを実装。
5. レシーバー(s) を起動し、webhook エンドポイント (/zoom/events) を Zoom に公開。
6. OAuth ワークロードのトークン/状態を永続化し、署名検証を強制。
7. モジュール固有の障害を監視し、変更ログの頻度に応じてシークレット/バージョンをローテーション。

高レベルシナリオ

• Team Chat スラッシュコマンドボット + Team Chat データ API エンリッチメント。
• マルチモジュールバックエンド (Users + Meetings + Team Chat + Phone) が 1 つのプロセスを共有。
• 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 アプリカード、コマンド、ボット UX: ../team-chat/SKILL.md
• Video SDK API 固有の動作と BYOS コンテキスト: ../video-sdk/SKILL.md

環境変数

• 標準化された .env キーと各値の検索場所については、references/environment-variables.md を参照してください。

運用

• RUNBOOK.md - 5 分間のプリフライトとデバッグチェックリスト。