# About the Conferencing API

The Conferencing API connects a Wix site's resources to video conferencing providers, such as Zoom and Google Meet, and creates video conferences through those providers. It gives you a single, provider-agnostic interface: connect a resource to a provider once, then create and manage conferences without writing provider-specific code.

Conferences are created for a resource, such as a [Bookings resource](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2) that represents a staff member. Once a resource is connected to a provider, you can create conferences on its behalf, for example to attach a video meeting link to a booked appointment. To show the meeting on a calendar entry, set the conference details on an [event](fallback::https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3), or set default conferencing details on a [schedule](fallback::https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3).

With the Conferencing API, you can:

- Connect a resource to a conferencing provider using OAuth, credentials, or a static custom link.
- Retrieve the providers available to the site and the connection methods each one supports.
- Create, update, retrieve, and delete video conferences through the connected provider.
- Retrieve a resource's connections and their status.
- Disconnect a resource from a provider.

## How connections and conferences fit together

A resource connects to a provider through one of three connection methods: OAuth, credentials, or a custom link. A resource can connect to several different providers, but to at most one connection per provider.

When you create a conference, you choose the provider with `appId`. When you omit `appId`, the service uses the resource's active connection, which is the one with the latest `connectedDate`. When the requested resource has no active connection, the service falls back to the business resource, a shared site-level account (`4e0579a5-491e-4e70-a872-d097eed6e520`). The conference's `resourceId` reflects the resource actually used, so on later Update Conference and Delete Conference calls, pass the same `appId` and `resourceId` that were returned when the conference was created.

Custom links behave differently from provider connections. A custom link is a static URL that the service returns as a conference without contacting a provider. Custom links don't support Update Conference, and the same link is reused for every conference created for that resource. Connecting a custom link again replaces the stored URL, description, and password. List Providers always returns the Custom Link provider as the last item.

## Access to resources

Any caller with access to the API can manage the business resource. To manage any other resource, the caller must either have full access to conferencing on the site, or be the Wix user associated with the staff member who owns that resource. Otherwise, the call fails with `PERMISSION_DENIED`.

List Connections returns every connection that matches the filter, sorted by `connectedDate` with the newest first. For connections of resources the caller can't manage, sensitive fields, such as the OAuth account email and the custom link password, are returned empty.

## Before you begin

It's important to note the following points before starting to code:

- A resource must be connected to a provider before you can create a conference for it. Otherwise, the call fails with `RESOURCE_NOT_CONNECTED`.
- Retrieve the available providers with List Providers. Each provider's `id` is the `appId` you pass to Connect and to the conference methods. Check `connectionMethods` to see which methods a provider supports before connecting.
- Update Conference works only with providers that support updates. Other providers, and all custom links, return `NOT_SUPPORTED_BY_PROVIDER`.
- Conferencing providers, such as Zoom and Google Meet, may enforce their own rate limits and quotas. Make sure your usage stays within the limits of the provider you connect to.

## Use cases

- [Connect a resource for automatic conferencing](fallback::https://dev.wix.com/docs/api-reference/business-management/calendar/conferencing/conference-v1/sample-flows#connect-a-resource-for-automatic-conferencing)
- [Create and attach a conference to your own event](fallback::https://dev.wix.com/docs/api-reference/business-management/calendar/conferencing/conference-v1/sample-flows#create-and-attach-a-conference-to-your-own-event)
- [Offer a custom meeting link](fallback::https://dev.wix.com/docs/api-reference/business-management/calendar/conferencing/conference-v1/sample-flows#offer-a-custom-meeting-link)

## Terminology

- **Conference**: A video meeting hosted by an external provider. The provider creates and stores the meeting, and Wix returns its details, such as the join URL and password.
- **Connection**: A link between a resource and a provider account. A resource creates conferences through its connections.
- **Connection method**: How a connection is established. OAuth authorizes a provider account, credentials authenticate with a username and password, and custom stores a static meeting URL.
- **Provider**: A conferencing service available to the site, such as Zoom or Google Meet. A provider's `id` is the `appId` used in requests.
- **Resource**: The entity a conference is created for. Referenced by `resourceId`.
- **Business resource**: A shared, site-level account (`4e0579a5-491e-4e70-a872-d097eed6e520`) used when no `resourceId` is given, and as the fallback when a resource has no active connection.


@sdk_package_setup

# Conferencing: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

## Connect a resource for automatic conferencing

A site owner wants the events of a service to include a video meeting link. When conferencing is enabled on a service, conferences are created and managed automatically for that service's events and schedules, with no Create Conference call from you. A conference is created and attached when an event or schedule is created, updated when the event is rescheduled, and removed when the event is deleted.

The conference is created using the event's resource. If that resource has no connection, the site's business resource is used as a fallback. If neither is connected, no conference is created.

To connect a resource for automatic conferencing:

1. Call List Providers and present the available providers to the site owner. Each provider's `id` is the `appId` you use in the next step.

1. Call Connect with `connectionMethod` set to `OAUTH`, the chosen `appId`, the resource's `resourceId`, and a `redirectUrl`. Redirect the site owner to the returned `oauthUrl`.

1. After the owner authorizes the account, the provider redirects to your `redirectUrl` with `?connectionId=<id>` on success or `?error=<code>` on failure. On success, the connection is ready, and conferences are managed automatically for the service's events under the conditions above.

## Create and attach a conference to your own event

If you manage your own calendar events rather than relying on a service's automatic conferencing, you can create a conference and attach it to an event yourself.

> **Prerequisite:** The resource has an active connection (see [Connect a resource for automatic conferencing](fallback::#connect-a-resource-for-automatic-conferencing)).

To create and attach a conference to your own event:

1. Call Create Conference with the `appId` and `resourceId`, along with the meeting's `title`, `startTime`, and `duration`. Store the returned `appId`, `resourceId`, and conference `id` with your event.

1. Attach the conference to your calendar event by calling Update Event in the Calendar Events API with the event's `conferencingDetails`, mapping the created conference as follows:

    - `conference.hostUrl` to `conferencingDetails.hostUrl`
    - `conference.url` to `conferencingDetails.guestUrl`
    - `conference.password` to `conferencingDetails.password`
    - `conference.id` to `conferencingDetails.externalId`
    - `conference.appId` to `conferencingDetails.provider.onlineMeetingInfo.appId`, with `conferencingDetails.provider.providerType` set to `ONLINE_MEETING` (use `CUSTOM` for a custom link)

    `conferencingDetails.hostUrl` and `conferencingDetails.guestUrl` are required when `conferencingDetails` is set. To apply a default conference to every event on a schedule instead, call Update Schedule in the Schedules API with `defaultConferencingDetails`.

1. Display the returned conference `url` to the participants.

1. If the event is rescheduled, call Update Conference with the stored `appId` and `resourceId`, then call Update Event again with the refreshed `conferencingDetails`. If the event is removed, call Delete Conference with the stored `appId`, `resourceId`, and conference `id`, and clear the event's `conferencingDetails`.

## Offer a custom meeting link

Some site owners use a single, fixed meeting room rather than a connected provider account. You can let an owner store a static meeting URL and use it for their conferences.

To offer a custom meeting link:

1. Call Connect with `connectionMethod` set to `CUSTOM` and `customOptions` containing the `conferenceUrl`, and optionally a `password` and `description`. Pass the resource's `resourceId`.

1. Once stored, the custom link is used like any other connection: it's used automatically for the service's events when conferencing is enabled, or you can create a conference for your own event with Create Conference, which returns the stored URL as the conference `url` without contacting a provider.

1. To stop using the custom link, call Mark Connection As Disconnected with the resource's `resourceId` and the Custom Link provider's `id`, as returned by List Providers, as the `appId`.

Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso