Building Connectors and Apps
When you create an app in the Zoom Marketplace, you gain the ability to use Zoom APIs for developing integrations as well as bots. Marketplace Apps allow you to automate many tasks including managing users, creating and updating meetings, user reporting, and content management. The App Marketplace platform allows for testing in your local environment, sharing completed apps with others, and the ability to publish your app to the Zoom Marketplace.
Click on the Develop dropdown in the header and choose Build App. Once you do this, you will be directed the following page:
If you plan to publish your app to the Zoom App Marketplace, Zoom offers three types of apps: the account-level app, user-managed app and Chat bot.
An account-level app has scopes set for management based APIs and typically helps manage users, reporting, and content for a Zoom account.
A user-managed app has scopes set for individual user permissions and user APIs and is typically used to help manage an individual user’s content.
A Chat bot is a bot that will work within our chat platform to communicate information to user’s that use your service/app.
If you don’t plan to publish your app to the Zoom App Marketplace, Zoom offers three types of apps: the account-level app, user-managed app and Webhook only app.
The first two types are the same, but a Webhook only app will allow you to generte webhooks from your Zoom account that will be sent to a endpoint you define.
App Credentials and Redirect URL
Make a note of your app credentials; these credentials allow you to generate a token that is utilized by Zoom OAuth, providing you access to REST APIs. Zoom offers development and production credentials. Utilize the development credentials during your development and testing phase. Zoom will also use these credentials during the approval process for your app. This will allow you to access user Zoom APIs from your app. These credentials should not be made public and should be stored safely. Provide your Redirect URL for both Development and Production; this is where we will send the token after the user authenticates with OAuth.
If you update your Redirect URL for OAuth or app name after generating a Publishable URL, you will be required to regenerate a new Publishable URL.
Zoom requires that you supply some basic information to ensure that users have a good understanding of the service(s) your app will provide. All fields are required unless otherwise noted.
Descriptions of each field are below:
App Name: Your app name will be displayed in the Marketplace and must be unique at the time of creation. Marketplace names are visible even if your app is not submitted publically.
Short Description: Provide a concise description of your app to give a general idea of your app’s functionality.
Long Description: Provide a complete description of your app, including its use, the permissions you’ll require, and any additional information a user installing your app may need to know.
Preview Images: Include any screenshots, images, or one video of your app describing it’s installation and use. For images, we support JPG, GIF, JPEG, PNG formats but the image size must be 1200x780 pixels. For video, we support MP4 format with a maximum file size of 10 MB.
Developer Contact Information (Name, Email Address): Point of contact for any inquiries about your app.
Support URL: We recommend that you provide complete support for your app. This can include a complete support system through your site, such as a customer help center or technical support team.
Configure URL (optional): You may have a separate configuration URL if any further configuration is necessary; this field is not required.
Installing Your App:
Choose how you want your users to install your app, you can either provide a landing page or have it installed from the Zoom Marketplace:
Landing Page: If installing via a hosted landing page, please provide the appropriate Direct landing URL for users.
Zoom Marketplace: Choose this option if you wish for users to install directly from the Marketplace portal.
White List (optional): Specify any URLs that you need to whitelist for your app. Be sure to provide the prefix from your OAuth redirect URL.
If you update your White List URLs at any time after generating a Publishable URL, you will be required to regenerate a new Publishable URL.
If a user decides to remove or deauthorize your app, you will receive a notification at your specified endpoint. Configure your endpoint in the specified box shown below:
The Zoom Marketplace allows you to subscribe to specific events and use Zoom Chat commands. This will let your app take immediate action when the desired event occurs for a user or the account within Zoom. Enabling Event Subscriptions allows you to receive notifications to your endpoints from Zoom. Enabling Chat Commands allows you to define a custom command when a user invokes your bot from the Zoom Chat.
For more information on subscribing to Zoom Events and Chat Commands please see our Webhooks Guide.