Skip to main content

Default OAuth 2.0 App

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 any preparation by project owners, but it depends on a preexisting AutoKitteh server-wide configuration.

If you want to use your own OAuth 2.0 app in your project(s), see the Private OAuth guide.

If you want to use your own Server-to-Server internal app in your project(s), see the Server-to-Server guide.

note

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​

  1. Sign into the Zoom App Marketplace

  2. Follow the instructions at: Create an OAuth app

  3. Go to the section "Basic Information > OAuth Information":

    • OAuth Redirect URL: https://PUBLIC-AK-ADDRESS/oauth/redirect/zoom
      (where PUBLIC-AK-ADDRESS is the AutoKitteh server's public tunnel address)

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
    (where PUBLIC-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 Server​

There are two equivalent options to configure the AutoKitteh server to interact with a Zoom OAuth app - choose the one most suited for your needs and constraints.

For more details, see the Configuration Methods page.

Lastly, restart the AutoKitteh server for these settings to take effect.

Environment Variables​

Set this environment variable, based on the AutoKitteh server's public tunnel address:

  • WEBHOOK_ADDRESS
    • Just the address, without the https:// prefix, and without a path suffix

Also set these environment variables, based on the values you collected in the App Details section above:

  • ZOOM_CLIENT_ID
  • ZOOM_CLIENT_SECRET
  • ZOOM_SECRET_TOKEN (required only if you want to receive events)

config.yaml File​

Will be implemented soon. Stay tuned!

AutoKitteh Connections​

When you create, initialize, or edit the connection in an AutoKitteh project:

  1. Select the "Zoom" connection type, if not selected yet

  2. Select the "Default OAuth 2.0 app" authentication type, if not selected yet

  3. Click the "Start OAuth Flow" button