Consolidating multiple apps using the new Zoom build flow

We're excited to introduce a new way for developers to build apps on Zoom using the new build flow. This allows you to create and manage a "general app" that provides app credentials and enables features for multiple app types such as SDK, API, and Webhook, integrating seamlessly across various Zoom Workplace products. For more details on the new build flow and other recent updates to the Zoom developer platform, check out this post.

Manually consolidating multiple apps

If you have created multiple apps before the introduction of the new build flow, you can now consolidate them into a single app. Although there is no automatic conversion process, you can manually integrate the required scopes and features into a single app, simplifying installation and usage for your users.

For instance, you might have an OAuth app that manages meetings and recordings and another app that allows users to join meetings using the Meeting SDK. With the new build flow, you can support both use cases in a single app. You could integrate the Meeting SDK capability into the existing OAuth app (after converting it to a general app) or vice versa. The following guide will help you determine the best way to consolidate your existing apps.

Key considerations for consolidating multiple apps

Before starting the consolidation process, take time to review and investigate the following:

Are all apps either Admin-managed or User-managed? Apps need to be the same, Admin or User level.
Can the apps share the same OAuth Redirect URL?
What scopes should become Optional scopes in the new “merged” general app?
Will combining these apps create a confusing or less user-friendly experience for users?
Users will need to re-authorize the app if new scopes are added. How will this impact the user experience?
How will you monitor, log, and report on app/user activity?

Steps to consolidate your apps

If you decide to consolidate your apps, follow these recommended steps:

1. Select the primary app: Decide which app your users should continue to use after consolidation. This app will be referred to as "App A," and the other apps as "App B." Ensure the name of "App A" is meaningful to all users of the consolidated app.

2. Login and prepare: Log in to the Zoom App Marketplace, select Manage, and choose "App A" that needs to be converted to the new build flow. The app will now display the new UI. Open "App B" in a separate browser window or tab.

3. Enable features and scopes: Review and manually enable the required features and scopes from "App B" in "App A”.

4. Update app listing: Review and edit the App Listing page in "App A" to ensure the app name, description, images, categories, etc., reflect all features and capabilities of the merged app.

5. Submit for review: Update the Technical Design Document and submit an update request to trigger the App Review process for “App A”. More information on the update request process is available here.

Consolidating more than two apps

When consolidating more than two apps into a single app, review the same information shared above and consider additional complexity. Ensure you are not introducing friction that could make it difficult for users to achieve the same results as with the existing apps. If the user experience remains positive, follow the same process for App C, App D, etc., until all required scopes and features are integrated into "App A."

Creating a new app instead of consolidating

After considering the potential impact of consolidating multiple apps, you might decide to create a new app. This approach allows your existing users to evaluate the new app before migrating from the existing ones.

Creating a new app can allow IT and security teams to test, review and approve the app before granting access to users, which can be especially helpful for customers in large enterprises, financial services, or government organizations. This means users can continue using the existing apps during the evaluation period, helping to provide uninterrupted adoption and utilization.

Private vs. public apps

Private apps are created for internal use within the organization and are not published to the Zoom App Marketplace, while public apps are distributed externally. Both types use the same build flow, but private apps do not need to complete the App Listing, Technical Design, and App Submission sections of the build flow. These sections are only visible when selecting the Production tab at the top of the Build Flow UI.

It's recommended to review the previous sections of this blog post while considering the needs and requirements of your organization and the internal users who will use the app.

By following these guidelines, you can effectively consolidate your apps, streamline the user experience, and leverage the full potential of the new Zoom build flow.