Private OAuth 2.0 Apps
Overview
A user-managed OAuth app enables you to securely integrate with Zoom APIs and webhooks on behalf of an authorized user.
This connection mode does not require a preexisting AutoKitteh server-wide configuration. Instead, it allows project owners to configure the details of their own apps.
If you want to use the AutoKitteh server's default Zoom OAuth 2.0 app, see the Default OAuth guide.
If you want to use your own Server-to-Server internal app in your project(s), see the Server-to-Server guide.
This guide assumes that the AutoKitteh server is already configured with HTTP tunneling.
Creating Zoom apps requires being a Zoom workspace admin, or receiving approval from one.
Zoom Documentation
Create an OAuth App
-
Sign into the Zoom App Marketplace
-
Follow the instructions at: Create an OAuth app
-
Go to the section "Basic Information > OAuth Information":
- OAuth Redirect URL:
https://PUBLIC-AK-ADDRESS/oauth/redirect/zoom
(wherePUBLIC-AK-ADDRESS
is the AutoKitteh server's public tunnel address)
- OAuth Redirect URL:
Events (Optional)
If you want to receive asynchronous events from Zoom, go to the section "Features > Access > Event Subscriptions", and add one or more subscriptions:
- Method: Webhook
- Event notification endpoint URL:
https://PUBLIC-AK-ADDRESS/zoom/event
(wherePUBLIC-AK-ADDRESS
is the AutoKitteh server's public tunnel address) - Authentication Header Option: Default Header Provided by Zoom
App Details
Basic Information > App Credentials:
- Client ID
- Client Secret
Features > Access:
- Secret Token
AutoKitteh Connections
When you create, initialize, or edit the connection in an AutoKitteh project:
-
Select the "Zoom" connection type, if not selected yet
-
Select the "Private OAuth 2.0 app" authentication type, if not selected yet
-
Enter the app details from the previous section:
- Client ID (required)
- Client secret (required)
- Secret token (required only if you want to receive events)
-
Click the "Start OAuth Flow" button