Zoom Service App

This guide will help you set up a Zoom Server-to-Server OAuth app for use with PPI Vantage. Please read through the entire tutorial before starting.

Step 1: Create the App

To begin, you need to create a Server-to-Server OAuth app on Zoom. Follow the instructions provided in the Zoom Internal Apps documentation: Zoom Internal Apps.

Step 2: Gather Credentials

For Vantage to authenticate with the Server-to-Server OAuth app, you need to obtain the following credentials from the App Credentials Page in Zoom:

Account ID
Client ID
Client Secret

Additionally, you will need the Secret Token from the Feature Page.

Step 3: Configure an Event Subscription

Enable Event Subscriptions

Navigate to the Feature Page in your Zoom app settings.
Enable Event Subscriptions.

Add an Event Subscription

Create a new event subscription called PPI Vantage Webhook.
Set the "Event notification endpoint URL" to: https://app.vantageportal.com/api/zoom/webhook/client_id
- PPI will provide a Base64 encoded client ID for you to use.

Validate the Endpoint

Coordinate with the PPI team to validate the endpoint. This ensures the correct verification of your identity and endpoint with Zoom.

Add Zoom Room Events

Add all Zoom Room events to the subscription. These events are associated with the room:read:admin scope and include:

Zoom Room Alert
Zoom Room Delayed Alert
Zoom Room Checked In
Zoom Room Checked Out
Zoom Room Sensor Data
Zoom Room digital signage app started
Zoom Room digital signage app ended
Zoom Room third party meeting attempted
Zoom Room Created
Zoom Room Deleted
Zoom Room Updated
Zoom Room Location Created
Zoom Room Location Updated
Zoom Room Location Deleted

Step 4: Add Required Scopes

Dashboard Scopes

Navigate to the "Scopes" tab in the app settings, click "Add Scopes," and search for 'Zoom Room'. Add the following 'read' scopes:

dashboard:read:list_zoomrooms:admin
dashboard:read:zoomroom:admin
dashboard:read:issues_zoomroom:admin
dashboard:read:list_meetings_feedback:admin
dashboard:read:meeting_feedback:admin
dashboard:read:meeting_quality_score:admin
dashboard:read:issues_zoomroom:master
dashboard:read:list_zoomrooms:master
dashboard:read:zoomroom:master

Room Scopes

Add the following 'read' scopes:

zoom_rooms:read:list_tags:admin
zoom_rooms:read:account_settings:admin
zoom_rooms:read:list_digital_signage_contents:admin
zoom_rooms:read:list_calendar_resources:admin
zoom_rooms:read:room:admin
zoom_rooms:read:alert:admin
zoom_rooms:read:list_calendar_services:admin
zoom_rooms:read:room_settings:admin
zoom_rooms:read:location:admin
zoom_rooms:read:location_settings:admin
zoom_rooms:read:list_devices:admin
zoom_rooms:read:list_device_profiles:admin
zoom_rooms:read:device_profile:admin
zoom_rooms:read:list_rooms:admin
zoom_rooms:read:room_control:admin
zoom_rooms:read:list_locations:admin
zoom_rooms:read:account_profile:admin
zoom_rooms:read:digital_signage_app:admin
zoom_rooms:read:calendar_resource:admin
zoom_rooms:read:location_hierarchy:admin
zoom_rooms:read:sensor_data:admin

Step 5: Activate the Integration

On the final page in the Zoom Portal app setup ensure that you activate the integration and securely forward all the credentials obtained in Step 2 to the PPI team.

By following these steps, you will successfully set up a Zoom Server-to-Server OAuth app for use with PPI Vantage. If you encounter any issues, consult the Zoom Internal Apps documentation or reach out to the PPI team for assistance.