Getting Started

Zoom Apps are installable within the Zoom Client and are created for the purposes of providing engaging experiences during and outside of a Zoom meeting. Our goal is to provide tools and resources that enable you to create and publish Zoom apps, and the power and reliability of the Zoom Platform.

Create a Zoom App

By creating an app under the Zoom Apps category in the Marketplace, you are taking the first step to integrating with Zoom services such as Zoom Apps APIs and Zoom Restful APIs. Your app calls the APIs on behalf of the Zoom users who authorize and install your app.

For a video walk-through, see How to Create a Zoom App.

Prerequisites

Register your app

To register your app, log onto the Zoom App Marketplace, click Develop, and select Build App. Select Zoom Apps as the app type and click Create.

Enter a name for your app and click Create again.

Generate app credentials

The app creation build flow automatically generates development and production app credentials (Client ID/ Client Secret) for your app. Use development credentials while you are building and testing your app. Use production credentials once you are ready to publish your app on the Marketplace. Redirect URL for OAuth: Provide a valid URL secured with HTTPS to which users will be redirected to after they successfully authorize your application.

Allow List URL: Add all unique URLs for Zoom to allow as valid Redirect URLs for your OAuth flows. This additional security measure ensures that users are redirected only to the pre-approved endpoints provided under the allow list. Make sure to include either the complete URL(https://[subdomain.]domain.tld/path/to/oauth/callback) or the base URL, omitting the path and/or query parameters(https://[subdomain.]domain.tld). This is a required step to secure your app and prevent unwanted tampering with your app during installation. To minimize the risk of sensitive data leakage, only include URLs that you have provided in the Redirect URL for OAuth field.

App’s Allow List Domains:

Add domains to be allowed for client and system browser communication such as valid iframe source and openURL endpoints that are used in your app.

Information

In this page, you must provide some basic information about your app including the Home URL of your app(the content in this URL will be rendered in the Zoom client after a user installs your app), the short and long descriptions about your app that provides users with a general idea about why they would want to use your app. You can select up to three categories that your app falls under. Additionally, provide preview images of your app (optional), your contact information, helpful links, installation site and a Deauthorization endpoint URL where your app will receive deauthorization notifications every time a user uninstalls your app.

Set features

You can enable additional features such as Event Subscriptions and Zoom App SDK APIs for your app. For information on Event Subscriptions, see Using Webhooks.

To utilize the Zoom Apps SDK API and events, you must enable the Zoom App SDK option and then click the Add APIs option to select the APIs and events used in your app.

Set scopes

Scopes define the API endpoints and methods that your app is allowed to use in order to access specified resources pertaining to your users. To explore and add available Scopes, click Add Scopes and scroll through the available access points your app will need.

Once your app is published, it will only be permitted to access the resources granted to it by its authorized scopes. Each request for a scope will be specifically reviewed by the Zoom Marketplace team on submission.

There are two scopes specific to Zoom Apps:

  1. zoomapp:inmeeting to make the app available in Meetings.
  2. zoomapp:inwebinar to make the app availble in Webinars.

Perform local test in the Zoom Client

The Local test tab enables you to generate local test credentials and preview your app in the Marketplace.
After this step, your app will be registered as a draft app and you will be able to integrate Zoom services and APIs in your application’s code.

The Local test section contains the following:

  • Test the App Locally
    Use this section to test your app's authorization.

  • Testable URL
    Generate a test URL to share with others in your account. This enables you to test your app locally in a development environment.

  • Preview URL
    The Preview My App link enables you to preview your app as it would appear in the Zoom App Marketplace. This link is generated when you create a publishable URL or upon app submission.
    Note: You can use the Submit tab to request that Zoom to make the app shareable within an account for testing purposes.

Submit

Use the Submit tab to submit your app for publication to the Zoom App Marketplace.

To keep your app private and shearable only with your account users, use the generated Publishable URL.

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.