Custom Zoom App

There may be situations where the published Zoom applications are not suitable for a customer's needs. This includes Nectar DXP running in customer's on-prem environments or in private cloud environments. In these cases, the customer can create their own custom private OAuth application in the Zoom App Marketplace. These apps do not appear in the App Marketplace. This document outlines the steps necessary to create a private Zoom OAuth application.

1. Log onto the Zoom App Marketplace using an account that has the rights to create applications.
2. Click the Develop button and select Build App. Alternatively, go directly to the Create App page.
3. On the What kind of app are you creating page, select General App and press the Create button.
   
4. On the top-middle of the page, select Production.
   
5. Under Basic Information - Select how the app is managed, select Admin-Managed and press Save.
   
6. Copy the Client ID and Client Secret to provide to Nectar personnel
7. Under OAuth Information, enter the URL that will be provided to you by Nectar personnel. The URL should end with /adminapi/zoom/oauth/authorize. Example: https://customer.us.nectar.services/adminapi/zoom/oauth/authorize
8. Under Oauth allow list, add the base FQDN. Example: https://customer.us.nectar.services
   
9. Press Continue to move to the next page.
10. On the Access page, copy the Secret Token to give to Nectar.
11. Under General Features - Event Subscription, set the toggle to enabled and press Add New Event Subscription
    
12. Ensure that Webhook is the selected method.
13. Set the Subscription name to something like Nectar DXP Webhooks
14. Under Events, click on Add Events
    
15. Select the following events and click Done:
    1. Meeting - End Meeting
    2. Webinar - End Webinar
    3. User - User has been created
    4. User -  User has been deleted
    5. User -  User's profile info has been updated
       
16. Under Event notification endpoint URL, enter the value that will be provided by Nectar support. Will be something like https://customer.us.nectar.services/zoom/event
17. Press the Validate button and ensure you get a positive response.
18. Click Save to return to the main screen, then press Continue until you get to the Add Scopes screen, skipping the Access and Surface sections.
19. On the Add Scopes screen, add the following 16 scopes (should be a total of 11 Dashboard scopes, 2 Meeting scopes, 2 User scopes and 1Webinar scope):
    1. dashboard:read:meeting_participant_qos:admin
    2. dashboard:read:meeting:admin 
    3. dashboard:read:list_meeting_participants:admin 
    4. dashboard:read:list_meetings:admin 
    5. dashboard:read:list_meeting_participants_qos:admin 
    6. dashboard:read:webinar_participant_qos:admin 
    7. dashboard:read:list_webinars:admin 
    8. dashboard:read:webinar:admin 
    9. dashboard:read:list_webinar_participants_qos:admin 
    10. dashboard:read:list_webinar_participants:admin 
    11. dashboard:read:meeting_quality_score:admin 
    12. meeting:read:meeting:admin (should already be there) 
    13. meeting:read:past_meeting:admin 
    14. user:read:user:admin (should already be there) 
    15. user:read:list_users:admin
    16. webinar:read:webinar:admin (should already be there) 
20. On the App Listing section, enter a name like Nectar DXP.
21. Enter a short description such as "Advanced call quality analytics, reporting and troubleshooting for your Zoom calls, conferences and webinars"
22. For the long description, enter some text, such as "The Zoom Admin Dashboard is an excellent meeting/webinar focused tool that allows you to see all your live and past meetings/webinars. It is not as well suited for finding and solving quality-related issues. Nectar DXP makes it easy to find issues that may be affecting your Zoom user's meeting experience."
23. Under the Developer Contact Information section, enter your name and email address.
24. Press Continue to move to the next page. 
25. WARNING

    The event notification URL must be active to continue. If you get an "Invalid URL" error message, ensure the URL is reachable via DNS.
26. Copy the Verification Token and provide to Nectar personnel.
27. Press Continue to move to the next page. 
28. On the Add Scopes page, click + Add Scopes and add the following scopes:
    • Meeting - View all user meetings
    • Webinar - View all user Webinars
    • User - View all user information
    • Dashboard
      • View overview of usage statistics for Meetings and Zoom Rooms
      • View all users' meetings information on Dashboard.
      • View all users' webinar information on Dashboard
    • Group - View groups
29. Click Done, then press Continue to move to the next page. 
30. Once at the Activation page, all steps are complete. Copy the Installation URL and share with Nectar personnel.

In summary, provide the following information to Nectar personnel:

• Client ID
• Client Secret
• Verification Token
• Installation URL