Zoom Rivet SDK

Référence documentaire pour Zoom Rivet en tant que framework serveur JavaScript et TypeScript pour les intégrations Zoom.

Guide d'implémentation pour Zoom Rivet (JavaScript/TypeScript) en tant que framework côté serveur pour :

• Gestion OAuth et tokens
• Consommation d'événements webhook
• Wrappers d'endpoints REST typés
• Composition de serveur multi-module

Docs officielles :

• https://developers.zoom.us/docs/rivet/
• https://developers.zoom.us/docs/rivet/javascript/
• https://zoom.github.io/rivet-javascript/

Exemples de référence :

• 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

Routing Guardrail

• Rivet SDK est un framework Node.js qui regroupe la gestion auth Zoom, les récepteurs webhook et les wrappers API typés.
• Rivet est recommandé pour un scaffolding serveur plus rapide, mais ce n'est pas obligatoire.
• Au démarrage de la planification, confirmez la préférence :
• Voulez-vous le SDK Rivet, ou OAuth direct + REST sans Rivet ?
• Utilisez Rivet quand l'utilisateur veut un serveur Node.js qui combine auth Zoom + webhooks + appels API avec un minimum de code de liaison.
• Si l'utilisateur a besoin uniquement d'appels API directs à partir d'un backend existant, chainez avec ../rest-api/SKILL.md.
• Si l'utilisateur se concentre sur le comportement des cartes/commandes de l'application Team Chat Zoom, chainez avec ../team-chat/SKILL.md.
• Si l'utilisateur a besoin d'un embed SDK (runtime client Meeting SDK/Video SDK), routez vers ../meeting-sdk/SKILL.md ou ../video-sdk/SKILL.md.

Quick Links

Commencez ici :

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. Choisissez les modules et le modèle auth par module (Client Credentials, User OAuth, S2S OAuth, Video SDK JWT).
2. Instanciez le(s) client(s) avec les credentials, le secret webhook et le port par module.
3. Enregistrez les gestionnaires d'événements (webEventConsumer.event(...) ou raccourcis).
4. Implémentez les appels API via client.endpoints.*.
5. Démarrez le(s) récepteur(s) et exposez le(s) endpoint(s) webhook (/zoom/events) à Zoom.
6. Persistez les tokens/état pour les workloads OAuth et appliquez la vérification de signature.
7. Surveillez les défaillances spécifiques aux modules et alternez les secrets/versions avec cadence de changelog.

High-Level Scenarios

• Bot commande slash Team Chat + enrichissement API données Team Chat.
• Backend multi-module (Users + Meetings + Team Chat + Phone) partageant un seul processus.
• Backend télémétrie Video SDK utilisant flux d'événements module videosdk + surfaces API.
• Couche orchestration ISV avec stockage tokens tenant-aware et webhooks par module.
• Processeur webhook AWS Lambda avec Rivet AwsLambdaReceiver.

Voir scenarios/high-level-scenarios.md pour les détails.

Chaining

• Architecture OAuth et sélection de grant : ../oauth/SKILL.md
• Sémantique d'endpoints API et détails payload de requête : ../rest-api/SKILL.md
• Cartes app Team Chat, commandes et UX bot : ../team-chat/SKILL.md
• Comportement spécifique API Video SDK et contexte BYOS : ../video-sdk/SKILL.md

Environment Variables

• Voir references/environment-variables.md pour les clés .env standardisées et où trouver chaque valeur.

Operations

• RUNBOOK.md - Checklist de préflight 5 minutes et débogage.