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 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, or set default conferencing details on a schedule.

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
• Create and attach a conference to your own event
• 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.