Zoom
Introduction
This guide explains how to obtain authentication details from Zoom, as well as installing a Zoom Connector.
Setup & Authentication
Overview
Your customer must:
Create an app in the Zoom App Marketplace to obtain OAuth 2.0 credentials.
Use these OAuth 2.0 credentials when installing the Connector into an account.
Remote Setup in Zoom - performed by your customer
The following setup process must be followed by your customer.
Your customer should:
Log into their Zoom account.
Navigate to the Zoom App Marketplace.
Select Develop > Build App.
Under the Select how the app is managed heading, select User-managed to manage a single user account.
Note the Client ID and Client Secret, these will be required when your customer installs the Zoom Connector into their account.
Under the OAuth Redirect URL heading, enter a redirect URL. This will have the format
https://[Your Cyclr Service Domain]/connector/callback.Under the OAuth Allow Lists heading, enter the same URL as the redirect URL. This will have the format
https://[Your Cyclr Service Domain]/connector/callback.From the left-hand navigation panel, select Features > Access.
Note the Secret Token, this will be required when your customer installs the Zoom Connector into their account.
From the left-hand navigation panel, select Scopes.
Select + Add Scopes and add scopes as required.
At least one scope is required to allow authentication to function correctly.
Cyclr Connector Installation
When installing the Zoom Connector, the following values are used:
Value | Description |
|---|---|
Client ID | The client ID from your customers Zoom App. |
Client Secret | The client secret from your customers Zoom App. |
Webhook Secret | (Optional) The webhook secret from your customers Zoom App. This is required when using webhooks with the Zoom Connector. |
Additional Information
Webhooks and event subscriptions
Webhooks must be configured in your customers Zoom App. Each webhook requires an event subscription to be configured. A single Zoom App can have multiple event subscriptions. From the Cyclr containing the webhook:
Select Step setup on the Webhook step.
Note the webhook URL, this will be required when creating an event subscription in the Zoom App.
Run the Cycle.
From your customers Zoom App:
From the left-hand navigation panel, select Features > Access.
Enable Event Subscription.
Select + Add New Event Subscription.
Enter a Subscription name.
Select + Add Events and add events that match the webhook.
Select Done.
Enter a Event notification endpoint URL. This should be the webhook URL noted above.
Select Save.
Each event has the required scopes listed underneath, these scopes must be added to the same Zoom App to enable the event subscription to function correctly.
Webhooks, event subscriptions, and scopes
The following table contains a list of Zoom Connector webhook methods, the corresponding event subscriptions, and the required scopes for these event subscriptions:
Methods | Event subscription | Scopes |
|---|---|---|
Meetings > Meeting Created | Start Meeting | Meeting’s read and write scopes |
Webinars > Webinar Created | Webinar has been created | Webinar’s read and write scopes |
Webinars > Webinar Registration Created | Webinar Registration has been created | Webinar’s read and write scopes |