Documentation

API Integration Guide

Use the WhiteLabelZoom RESTful API to manage meetings, users, recordings, and platform settings programmatically. Build custom integrations, automate workflows, and embed video conferencing into your existing applications.

API Overview

The WhiteLabelZoom API is a RESTful interface for managing every aspect of your video conferencing platform. Create and schedule meetings, provision user accounts, retrieve recordings, and update platform settings — all through standard HTTP requests that return JSON responses.

The API runs on your self-hosted instance, meaning all requests stay within your infrastructure. There are no external API gateways or third-party intermediaries. Your data never leaves your servers.

Authentication

WhiteLabelZoom supports two authentication methods depending on your integration needs.

API Key Authentication

Generate API keys in the admin dashboard for server-to-server integrations. Include the key in the Authorization header of every request. Ideal for backend services, automation scripts, and CI/CD pipelines.

JWT Tokens

Use JSON Web Tokens for user-level access. Authenticate users through your identity provider and pass the signed JWT to access user-scoped resources. Supports standard claims for role-based permissions.

Key Endpoints

The core API endpoints cover meeting management, user provisioning, recording retrieval, and platform configuration.

MethodEndpointDescription
POST/api/meetingsCreate a meeting
GET/api/meetings/:idGet meeting details
POST/api/usersCreate a user
GET/api/recordingsList recordings
PUT/api/settingsUpdate platform settings

See the full endpoint reference on the API Reference page.

Webhooks

Receive real-time notifications when events occur on your platform. Configure webhook URLs in the admin dashboard and WhiteLabelZoom will send HTTP POST requests with event payloads to your endpoints.

meeting.started

Fires when a meeting begins and the first participant connects to the media server.

meeting.ended

Fires when a meeting concludes and all participants have disconnected.

recording.ready

Fires when a meeting recording has been processed and is available for download or playback.

user.joined

Fires when a participant joins an active meeting room.

user.left

Fires when a participant leaves an active meeting room.

Rate Limits

The API enforces a rate limit of 100 requests per minute per API key. Exceeding this limit returns a 429 Too Many Requests response. Rate limit headers are included in every response so your application can throttle accordingly.

SDKs & Libraries

The WhiteLabelZoom API is a standard REST interface that works with any HTTP client in any programming language. No proprietary SDK is required. Use cURL, fetch, axios, requests, or any library you prefer.

Example: Create a Meeting (cURL)

curl -X POST https://your-domain.com/api/meetings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Team Standup",
    "scheduled_at": "2025-01-15T09:00:00Z",
    "duration": 30,
    "password": "secure123"
  }'

Embedding Meetings

Embed WhiteLabelZoom meeting rooms directly in your application using an iframe or a direct URL. Each meeting room has a unique URL that participants can join from any modern browser — no plugins, no downloads.

For iframe embedding, set the allow attribute to include camera; microphone; display-capture so participants can use their devices within the embedded frame. Pass JWT tokens as query parameters to authenticate users automatically.

<iframe
  src="https://your-domain.com/meeting/ROOM_ID?jwt=USER_TOKEN"
  allow="camera; microphone; display-capture"
  style="width: 100%; height: 600px; border: none;"
></iframe>

Start Building with the API

Explore the full API reference, set up user management, or check out all platform features.

API ReferenceUser ManagementFeatures