Zoom SDKs provide a subset of features that are available in the Zoom Client app that can be integrated into your native apps. Zoom SDKs offer video-conferencing features that mirror the meeting experience in the Zoom Client and are compatible with various languages, platforms, and frameworks. Explore our available Zoom SDKs for more specific platform information.
- Create or update
- App name
- App credentials
- Local test
- SDK Activation
- Update app
To create an SDK app, click Develop and choose Build App.
In the SDK section, click Create.
The Zoom account
Admins, or users with the
Developer Role-Based Access
Control permission can create a Meeting SDK App type.
Add a name for your app, up to 50 characters. If you publish your app, this name will be displayed on the Zoom App Marketplace.
Choose whether you’d like to publish the app on the Zoom App Marketplace.
By default, Zoom gives you the option to publish your SDK app on the Zoom App Marketplace, where users can discover and add it. Click the switch to toggle this selection off if you do not want to publish it. You can choose to publish it later if you want.
Note that you have to go through a review for your app before your app is published. See App Submission for details.
Add information about your app and optional tags to categorize it on the Marketplace.
Fill out descriptive and contact information for your app.
- App name: The name of your app. This is the same information you entered when you initially created the app type. You can change the name here if you like.
- Short description: A description of what your app does.
- Long description: Add a long description and any marketing content that you’d like to share with others when they find your app on the Marketplace.
- Preview content: Upload a maximum of six images for your app’s detail page, or five images and one video. The Marketplace supports JPG, JPEG, GIF, and PNG image and MP4 video file formats. Image resolution must be 1200 by 780 pixels. The maximum video size is 40 MB.
- Company Name: Add your company name. This name will appear on the Marketplace and in your app’s detail page.
- Category: Select up to three Marketplace categories that best describe your app. These categories will determine where your app shows up in the Zoom App Marketplace. Learn more
Optimize your app’s discovery by adding additional tags. This information will solely be used for Zoom’s internal purposes in identifying the proper segmentations to market your app.
- Industry Vertical: Select an industry segment that best represents who your app provides services to.
- Customer: Add one or more relevant customer segments for your app.
- Audience: Add one or more relevant audiences for your app.
Add contact information for service announcements, Marketplace and API updates, and other information that may impact your app or Marketplace listing. You must provide a name and an email address.
Download the SDKs for the OSes that your app will support. See Zoom Meeting SDKs for details.
Zoom generates the following credentials:
- SDK credentials to authenticate your app with Zoom. You can also use these credentials to anonymously join a meeting with the meeting number and passcode.
- OAuth credentials that you can use to access Zoom APIs.
See Authentication for details.
In order to allow your app to integrate, the Zoom platform generates a set of unique credentials used to generate the tokens needed to authorize each request.
Here you will see a unique set of App Credentials generated for you by the Zoom Marketplace including an SDK Key and SDK Secret.
Once you have accessed these credentials, copy them over or refer back for usage during development.
If you chose to publish your app, you’ll see two sets of OAuth credentials, one for development and one for production. Zoom automatically generates the Client ID and Client Secret for both.
- Use development credentials to build and test your app.
- Use production credentials when you publish your app on Zoom App Marketplace. The Zoom App Marketplace team will also use these to test your app.
For your development and production credentials, provide a valid, HTTPS-secure URL to which users will be redirected after successfully authorizing your application. For example,
Note: Alternatively, you can use a non-HTTPS private-use URI scheme using PKCE to authenticate with Zoom, for example, if you would like to complete the OAuth flow without a backend server. See Using Proof Key for Code Exchange (PKCE) for details.
Add any unique URLs that Zoom should allow as valid redirect URLs for your OAuth flows. This additional security measure ensures that users are only redirected to the provided pre-approved endpoints.
After you enter the URL, you do not need to press a button to save it. To add additional URLs, click Add a new one. Click Remove to remove one.
https://subdomain.domain.tld/path/to/oauth/callbackor the base URL without the path and/or query parameters:
This is a required step to secure your app and prevent unwanted tampering with your app when users are adding it. To minimize the risk of sensitive data leakage, only include the URLs you provided in the Add allow lists field.
The Scopes tab lets you define the API endpoints that your app is allowed to use to access specific user resources.
To add scopes to your app, click Add Scopes. Select the desired scopes for your app, then click Done.
The Scopes tab will display all the scopes chosen for your app:
For each scope, you must provide a description for how your app uses the scope.
Once your app is published, it will only be allowed to access the resources granted to it by its authorized scopes. Each request for a scope is reviewed by the Zoom App Marketplace team upon app submission.
If you are publishing your app, the SDK OAuth Local tab lets you 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.
See Authentication for details about supporting OAuth in your app.
The Local test section contains the items below.
Use the Add and Remove buttons in this section to test your app's authorization.
Use this section to generate a test URL to share with others in your account. This lets you test your app locally in a development environment. Click Generate to generate a testable URL.
Use this URL to preview your app.
Use the Submit tab to review and submit your app for publication in the Zoom App Marketplace. You must review and complete any missing information before you can submit your app for review.
Click Add or copy the Add URL to get an OAuth token.
If you previously decided not to publish your app and you’d now like to publish it, click Change Now. See Change Publication State to learn more.
Until then, you can’t share your app with users outside of your Zoom account.
If you created an SDK app in the past, you may need to update it to include the new OAuth credentials. To do so, click Manage, then click Update next to your SDK app. In the modal, click Update to update your app. You can also choose whether or not you’d like to make your app public.