API v2

Zoom Integration

Configure Zoom bots with SDK credentials, OBF tokens, and secure credential management in v2

Zoom Integration

Meeting BaaS v2 provides enhanced Zoom integration with secure credential management, improved OBF token handling, and better error tracking.

March 2, 2026 Deadline: Zoom requires OBF tokens for bots joining external meetings. If your bots join meetings hosted by external Zoom accounts, you must implement OBF tokens before this date. See OBF Token Support for details and Zoom's official announcement.

What's New in v2

The v2 API introduces several improvements for Zoom integration:

Featurev1v2
Credential StorageSeparate OAuth connection endpointUnified /v2/zoom-credentials API
SDK CredentialsPassed with each bot requestStore once, reference by ID
EncryptionBasicAES-256-GCM for secrets and tokens
Credential TypesOAuth onlyApp-only (SDK) and User (OAuth)
State TrackingLimitedActive/Invalid with error tracking
ConfigurationMultiple top-level paramsSingle zoom_config object

Two Approaches

How you integrate with Zoom depends on whose meetings your bots join:

Quick Decision Guide

Your Use CaseWhat You NeedDocumentation
Recording your team's meetingsApp-only credentialsZoom Credentials
Building a product for customersUser credentials with OBFOBF Token Support
Joining meetings hosted by othersOBF tokensOBF Token Support
Already managing OAuth yourselfDirect token or Token URLOBF Token Support

The zoom_config Object

In v2, all Zoom-specific configuration is passed in a single zoom_config object:

{
  "bot_name": "Recording Bot",
  "meeting_url": "https://zoom.us/j/123456789",
  "zoom_config": {
    "credential_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Available options within zoom_config:

ParameterDescription
credential_idUUID of a stored credential (recommended for most use cases)
credential_user_idLook up stored credential by Zoom user ID
obf_tokenDirect OBF token for one-off joins
obf_token_urlURL that returns an OBF token at join time
zak_token_urlURL that returns a ZAK token for host-level access

Pages in This Section

Key Concepts

Credential Types

App-only credentials store your Zoom app's SDK credentials (client ID and secret). Use these when your bots only join internal meetings.

User credentials store OAuth tokens for a specific Zoom user who authorized your app. These enable OBF token support for joining external meetings.

Credential States

v2 tracks credential health:

  • active: Credential is working and can be used
  • invalid: Credential has failed (e.g., tokens revoked, refresh failed)

When a credential becomes invalid, last_error_message and last_error_at provide debugging information.

Security

All credentials are encrypted at rest using AES-256-GCM. Client secrets and OAuth tokens are never returned in API responses—only credential IDs and metadata.

FAQ

On this page