Integration: Zoom - TRP

Modified on Wed, 3 Jan at 8:21 AM

TABLE OF CONTENTS

Introduction
Definitions
Data Gathered
Integration and Organization’s Firewall (if applicable)
Integration

Introduction

The purpose of this document is to describe the Zoom integration process with TRP.

Definitions

TRP: Telehealth Resource Program
Organization: TRP client, the health care entity
Zoom: Tele-conferencing software
Polling data: the ability to fetch data from a remote system

Data Gathered

TRP gathers zoom meetings/participants and QOS data. The details are listed below. Many fields are scrubbed by Zoom when HIPAA compliance is concerned.

Zoom Meeting

This module tracks the meetings that occurred. Following data is collected for this purpose.

Unique Meeting ID, Meeting Host, Host Email, Host ID, User Type, Topic, Meeting Type, Start Time, End Time, Timezone, Meeting Created At, Duration, Join URL, Host Account ID, Agenda, Issues, PSTN Used, VoIP Used, Third Party Audio Used, Video Used, Screen Share Feature Used, Recording Feature Used, SIP Used to Join, Department of the Host

Zoom Participants

This module tracks where the participant joins the meeting.

External Identifier, Name, Email, Meeting UUID, User ID, User Name, Device, IP Address, Location, Network Type, Microphone, Speaker, Camera, Data Center, Connection Type, Join Time, Leave Time, iPhone/iPad App Shared, Shared Dashboard, Share Whiteboard Used, Recording Feature Used, PC Name, Domain, Mac Address, Hard Disk ID, Version, Leave Reason

Zoom QOS

This module tracks individual participants' call quality data.

Bit Rate, Latency, Jitter, Average Loss, Max. Loss for output and input, video and audio. Video metrics also include frame rate and resolution. TRP also gets min, max and average CPU usage.

Integration and Organization’s Firewall (if applicable)

TRP can be hosted in Ignis Health’s cloud based infrastructure. In such a case if the Zoom system resides behind a firewall, TRP will need to be granted access to Zoom for API Calls. Ignis Health will provide the organization with the IP of TRP instances to provision such access. Ignis Health will also let the client know about this requirement when applicable.

Integration:

The integration process required on both Zoom and TRP side is explained step by step here.

Step 1:

Go to the Zoom App MarketPlace by clicking the link https://marketplace.zoom.us/ and sign in to Zoom with your Zoom account.

Step 2:

Go to the Develop menu on the top and click on the Build App option encircled in the figure below.

Step 3:

Clicking the Build App option will take you to the following page. Here you will click the Create button in the OAuth Box. This will create an OAuth Zoom App.

Step 4:

Choose a name for your Zoom App, toggle off the intent to publish option and create it.

Step 5:

Now that your Zoom OAuth App has been created with the name you entered, you will be redirected to your App.

This app has five sections displayed in the left navigation: App Credentials, Information, Feature, Scopes and Activate.

Step 6:

In the App Credentials section you can see your Client ID and Client secret, we’re going to copy these to TRP side. Click the continue button at right bottom to move to the Information section.

In the Information section, fill out the information, since its required to complete the integration process.

You can click Continue button in the bottom to move to the Features Section.

Step 7:

Goto TRP site, and in the side navigation panel, under the "Imports and Integrations section", click on Zoom Instance button.

This will take you to another view with existing Zoom Instances. Click on the Add Zoom Instance option from here.

After clicking that option, you will see a form which will ask you for:

Name (your integration instance name)
Client ID (from your Zoom App under “App Credentials” section)
Client secret (from your Zoom App under “App Credentials” section)
Secret Token (from your Zoom App under “Feature” section
Also select options for which you want to get data from zoom (Meetings/Meeting Details/Participants/ParticipantsQOS)

VI. Click on Save, this will take you to this view

VII. From this view we need to copy “Redirect URL” and “Zoom Webhooks URL” to our Zoom App.
VIII. Clicking on these buttons at bottom will allow you to copy these urls.

Step 8:

Paste Redirect URL copied from TRP under the App Credentials section of your Zoom OAuth App in the field named “Redirect URL for OAuth” just below “Client secret” and also in the field “Add allow lists” under OAuth allow list .

Step 9:

Clicking on continue after pasting Redirect URL will take you to Information section.

In the Information section, fill the required information and click Continue button in the bottom to move to the Feature section.

Step 10:

The Feature section contains the Event Subscriptions Under General Features option. Turn the event subscriptions on and you will see the following interface.

Event Subscription:

Fill the event subscription form as described below.

(i) Choose your subscription name.

(ii) Paste the “Zoom Webhooks URL” from your Zoom Instance we copied earlier, in the “Event notification endpoint URL” field.
Please, note the slash ‘/’ at the end of the URL. Do not miss it as it is a part of the URL.

(iii) Click on the Validate button

Adding Events:

Now click the “Add events” button you see in the bottom of the form. It will open a number of events for you. Please, mark the following events required by TRP.

From Meeting Tab :

End Meeting

From User Tab:

User has been created

User has been disassociated

User has been deleted

User has been activated

User has been deactivated

User's profile info has been updated

User has accepted the account invitation

From User Activity Tab:

User has signed in

Mark the above events and click Done. Save this subscription and click on continue.

Step 11:

Now you’re at Scopes section.

Two Scope permissions are already added from the features we selected, just need to add one more.
Click on the Add Scopes button. Goto Dashboard section and select the following option.

Click on Done and then continue.

Step 12:

Now you’re at Activation section.

Clicking on the Add button here will redirect you to another page asking for permissions.

Hit Allow and this will redirect you to the TRP side.

Check for a success message if you were already logged in to TRP or else you’ll have to login first.

Important Note

TRP validates the API key and API secret. However, it does not validate the verification token. Please, make sure that you enter the correct token in order to integrate correctly with TRP.
If you change your API secret or verification token on Zoom Side, please, make the respective changes on TRP side as well.