Skip to main content

Zoom Integration Customer Guide

Leighanne Jarvis
Updated

The Greenlight Program Management team can help facilitate the needed steps to accurately set up your organization Zoom’s account to enable the Pattern Health integration. The below guide steps through the appropriate steps. 

Zoom Apps

Two Zoom applications are required to use the Pattern Health (Greenlight) Zoom integration. 

  1. Server-to-Server OAuth app: enables the use of Zoom APIs from the PH server
  2. Meeting SDK app: enables direct integration of the Zoom client into the PH mobile apps. Allowing study participants and patients the ability to join Zoom meetings directly from the Pattern mobile apps. 

Depending on your organization’s Zoom account set up you may be required to create a Zoom-sub account to facilitate the study set up. This can be done by someone with Zoom administration access. The following steps apply for sub-accounts as well as full accounts. 

Configuring the Server-to-Server OAuth App

Prerequisites: Zoom administrative access

Steps:

  1. Login to Zoom via a browser
  2. Under the Admin section, select “Advanced -> App Marketplace”
  3. On the App Marketplace page, click on the “Develop” drop-down in the upper right
  4. Choose “Build App”
  5. Choose Server to Server OAuth App and click “Create”
  6. Enter a name for your app and click “Create”
  7. Observe: the Account ID, Client ID, and Client Secret are listed once the app is created. Save these values as you will need to use them in the Pattern Health Study Manager Console to set up your Zoom connection. Keep in mind that these are sensitive identifiers so treat them accordingly.
  8. Click on “Information” in the left navigation menu
  9. Enter the appropriate information for each requested field
  10. Click on “Scopes” in the left navigation
  11. Click on “Add Scopes” and choose the following permissions to add to the app:
    1. View account info /account:read:admin
      View all user meetings /meeting:read:admin
    2. View and manage all user meetings /meeting:write:admin
    3. View and manage sub account’s user meetings /meeting:master
    4. View all user recordings /recording:read:admin
    5. View and manage all user recordings /recording:write:admin
    6. View and manage sub account’s user recordings /recording:master
    7. View all user information /user:read:admin
    8. View and manage sub account’s user information /user:master
    9. View users information and manage users /user:write:admin
  12. Click on “Activation” in the left navigation
  13. Once you’re ready to activate your app, click “Activate your App”
    1. You should see a confirmation indicating that your app is live and activated on the account

Configuring the Meeting SDK

Prerequisites: Zoom administrative access

Steps:

  1. Log into Zoom
  2. Under the Admin section, click on “Advanced -> App Marketplace”
  3. On the App Marketplace page, click on the drop-down in the upper right that says “Develop”
  4. Choose “Build App”
  5. Choose General App and click “Create”
  6. In the left navigation, click on “Basic Information” and ensure the app is User-managed. This page contains the Client ID and Client Secret which you will need to reference these values when configuring the connection in the Console. Keep in mind that these are sensitive identifiers so treat them accordingly.
  7. In the left navigation, click on “Scopes” then click on “Add Scopes” and choose the following permissions to add to the app:
    1. View your meetings /meeting:read
    2. View your recordings /recording:read
    3. View user’s zak token /user_zak:read (this is selected by default)
  8. Note: At the top of the page there are 2 options to choose from: Develop & Production. Develop should be selected by default, but be aware that each of these have different sets of credentials. The Development credentials should be used while testing and should be switched to Production once your program goes live.

The app should be auto saved so there is no need to save anything. App setup is now complete.

Creating new Zoom Users (aka hosts)

Prerequisites: Zoom administrative access

All users that will set up and host Pattern Health Zoom meetings will need to have Zoom user accounts. These accounts can either be created or you can use existing accounts as long as all users have a user type of Licensed.

Zoom meeting participants are not required to have a Zoom account in order to join a meeting.

Configure Zoom integration in the Pattern Health Study Manager Console

Navigate to the group where all of the Zoom credentials will be entered. This should likely be the main Study group. If you have any questions please reach out to your Pattern Health Program Manager or via Support at support@pattern.health. 

Prerequisites: 

  1. Permission to manage Zoom credentials in the Pattern Health Study Manager
  2. Server-to-Server application created (see above)
  3. Meeting SDK application created (see above)

Steps:

  1. Login to the Pattern Health Study Manager 
  2. In the left navigation panel, click on Settings -> Integrations -> Zoom
  3. Enter the appropriate data for each field:
    1. Zoom Auth URL: only enter a value for this field if you have a vanity url that is in use for your Zoom account
    2. Zoom Account Id: Taken from the Server-to-Server application created above
    3. Server-to-Server App Client ID: Taken from the Server-to-Server application created above
    4. Server-to-Server App Client Secret: Taken from the Server-to-Server application created above
    5. SDK App Client ID: Taken from the General application created above
    6. SDK App Client Secret: Taken from the General application created above
  4. Click “Test” to validate the credentials
    1. Note: This test only validates the server-to-server credentials listed

Add Zoom Hosts in the Pattern Health Study Manager Console

Prerequisites: 

  1. A group admin has been created for every study admin who will be hosting meetings
  2. The Zoom integration has been configured in the Pattern Health Study Manger Console 

Steps:

  1. Navigate to the group where all of the Zoom credentials will be entered (this should be the same group as the previous step)
  2. In the left navigation panel, click on Settings -> Integrations -> Zoom
  3. In the “Admin User Settings” panel, click “Edit” and then “Add Admin”
  4. Choose the appropriate group admin from the dropdown and enter either the email address that was used to create the user in Zoom or their Zoom User Id
  5. Click “Test” to validate the information entered
  6. Click “Save”
  7. The admin should now have access to create Zoom meetings 

Comments

0 comments

Article is closed for comments.

Powered by Zendesk