Files
2026-07-13 12:20:06 +08:00

1.1 KiB

Rivet Reference Map

Canonical Documentation

Modules (TypeDoc)

From @zoom/rivet TypeDoc module index:

  • Accounts
  • Chatbot
  • Meetings
  • Phone
  • Team Chat
  • Users
  • Video SDK

Each module generally exposes:

  • *Client class(es)
  • *Endpoints wrapper class
  • *EventProcessor
  • HttpReceiver and AwsLambdaReceiver
  • Shared option/types/error surfaces

Key API Shapes

  • Event subscription:
  • client.webEventConsumer.event(eventName, handler)
  • Event shortcut examples:
  • onSlashCommand, onButtonClick, onChannelMessagePosted
  • Endpoint wrappers:
  • client.endpoints.<group>.<operation>({ path, query, body })