'BYO' Zoom Integration Instructions
This guide provides the steps required to integrate and configure your Zoom instance with ConveyIQ to support the Live interviews solution as part of the ‘Bring Your Own’ Zoom settings.
It includes the following sections:
- Integration Features
- Requirements
- Configuration Steps
Integration Features
The following Zoom Integration features are supported:
| Feature | Description |
|---|---|
| Creating Zoom Meetings | Each Zoom meeting will be created using a temporary user account and listing specified interviewers as alternative hosts. The temporary user will be of type ‘Licensed’ unless there is a limit in which case a ‘Basic’ user will be created. The temporary user will be deleted after the meeting is completed. |
| Deleting Zoom Meetings | Zoom meetings created by ConveyIQ will be deleted one by one 2 hours after each meeting is completed. |
| Event Subscriptions | ConveyIQ will subscribe to the following Zoom events:
|
Requirements
Connecting ConveyIQ to your Zoom instance requires creating a ConveyIQ JWT application in Zoom. The application is created manually through the Zoom App Marketplace. After this, the API credentials of this application need to be entered in ConveyIQ through a dedicated ‘Zoom Authorization’ flow.
Preconditions:
- You need Admin access for your organization Zoom account.
- You need Admin access to your company account in ConveyIQ.
Account Security - Passcode Requirements
For the best experience using Live interviewing with ConveyIQ we strongly recommend the use of Zoom encrypted passcodes for the meetings instead of Waiting Rooms.
Please make sure that the following settings are enabled and locked on your Zoom account settings level:
- Enable and lock the option: ‘Require a passcode when scheduling new meetings'
- Enable and lock the option: ‘Embed passcode in invite link for one-click join’
These settings will generate a passcode for every Zoom meeting that will be encrypted with the meeting invite URL, making sure the flow is secure and at the same time does not require any additional user action.
Configuration Steps
The following steps need to be completed to enable 'Bring Your Own' Zoom Integration with ConveyIQ:
- Create a JWT application in the Zoom App Marketplace
- Authorize API access through ConveyIQ Company Settings.
Step 1: Create a JWT application in the Zoom App Marketplace
- Login to Zoom with an Admin account
- Go to https://marketplace.zoom.us/
- In the top right corner of the header, click 'Develop' menu d. Select the 'Build App' option
- Click the 'Create' button in the JWT section
- You should see the ‘Information’ section of the App build flow
- Enter an App Name, e.g.: ConveyIQ Apph. Enter the Company name: Entelo
- Enter the Contact details.
- Skip the Links section
- Click the 'Continue' button
- The next section 'App credentials' is auto-populated, copy the API Key and API Secret as you will need them in step 2 of this setup.
- Click the 'Continue' button
- Skip the 'Feature' section as you will come back to is after the activation
- Click the 'Continue'button
- Now active the app by clicking the 'Activate your app' button
- If successful, go back to the 'Features'tab and click the toggle button to enable the 'Event Subscriptions'
- Click the 'Add new event subscription' button
- Name the event: Meeting Notifications
- Enter the following 'Event notification endpoint URL': https://live-connector.na.conveyiq.com/zoom/meeting_events
- Click the ‘Add events’ button
- Tick the following events:
- 'End Meeting'
- 'Participant/Host joined meeting'
- Recording > 'All recordings have completed'
- Click the 'Done'button
- Click the 'Save' button
- Copy the Verification Token as you will need them in step 2 of this setup.
Step 2: Authorize API access through ConveyIQ Company Settings
- Login to ConveyIQ with a Company Admin account
- Go to the Settings page > Company Tab
- Expand the 'Zoom Authorization' section
- If you have completed STEP 1 of these instructions, you are ready to complete the authorization by clicking the 'Authorize Zoom'button
- In the modal, enter the credentials obtained in STEP 1 when creating the JWT application:
- API Key
- API Secret
- Verification Token
- Click the 'Submit' button.
- If your authorization was successful, the integration is all set.
- If you are receiving a fail confirmation, contact Support.
The Zoom integration is now set, you can start using the Live interviewing feature!