Zoom integration can only be configured by the Civica Learning support team. To enable this feature, first please ensure that you meet the pre-requisites listed below as we cannot configure Zoom integration if you do not meet these requirements.
If you meet the initial requirements, please proceed to the pre-configuration steps, which involve us providing you with some information that you will require to complete the configuration steps. After you complete the configuration steps, you will have all of the information required for us to configure your Zoom integration. Please submit a support ticket with the required information (detailed below) for us to complete the process. Please allow 5-10 business days for this to be completed.
Pre-requisites
To use the Zoom integration, your session organisers must have paid Zoom accounts. For example they must each have a Pro or Business plan. Basic (free) accounts cannot be used with the Civica Learning Zoom integration, and enrolments using unpaid accounts will fail.
Each of these accounts must be included in the same account. This will be the case where the users have been added to the account by using the Admin > Users page in the Zoom portal, such as shown below. The email address of the organiser used in the Zoom portal must exactly match the email address of the organiser on the Civica Learning platform.
In addition to users having a paid account, you may also want to assign Webinar licenses to your users. After the Zoom integration is configured, organisers will be able to create Zoom meetings where they have a paid account, or optionally a Zoom webinar where they also have a Webinar add on.
Configuration - Part 1
- In the Zoom portal, access the App Marketplace.
- On the Develop menu, click Build App.
- In the Server-to-Server Oauth box, click Create.
- Provide a suitable name for the app, such as Civica, the name is not important and can be anything to suit your requirements.
- On the App credentials page, and make a note of the Account ID, API Key and API Secret. You will need to provide all of these values to the Civica Learning support team to complete the configuration.
- Navigate to the Information page, and complete the Company Name, Name and Email address fields. You can provide any values for these fields, however we would recommend adding the details of an appropriate person to be notified of service related events with this integration within your organisation.
- Navigate to the Feature page, and make a note of the Secret Token. You will need to provide this value to the Civica Learning support team to complete the configuration.
- Navigate to the Scopes page, and verify that the View all user meetings scope is included by default.
- Click Add Scopes, and then select the following scopes:
- Meeting: View and manage sub account's user meetings
- Meeting: View all user meetings
- Meeting: View and manage all user meetings
- Webinar: View and manage sub account's user webinars
- Webinar: View all user webinars
- Webinar: View and manage all user webinars
- User: View all user information
- Report: View report data
- After adding the eight required scopes, click Done.
Configuration - Part 2
To complete the Zoom integration you will require two URLs which you will use when creating event subscriptions. To obtain these URLs, please submit a support ticket stating that you require the configuration information to enable you to configure the Zoom integration.
Please provide the following information in the ticket:
- The URL of your administration portal
- If you have more than one administration portal that you want to configure please provide the URL of each; we will need to provide you with two URLs per administration portal
- The following values from your Zoom account (captured during Part 1):
- Account ID
- API Key
- API Secret.
- Secret Token
After we process your request we will provide you with the two URLs, to enable you to proceed to Part 3 of the configuration process.
Important: The the API key and API secret should be treated like a username and password, and therefore should not be sent in the same email. Please therefore do not include the API secret in the first support ticket, and instead raise a second support ticket to provide the API secret.
Configuration - Part 3
- In the Zoom portal, access the App Marketplace.
- Click Manage, and then in the list of Apps, click the App that you created in part 1 of this process.
- Navigate to the Features page, and then enable Event Subscriptions. This is necessary to allow Civica Learning to automatically retrieve attendance records following the completion of a Zoom meeting or webinar.
- Click Add event subscription, and then provide the name Civca Zoom Meeting Subscription (or some other name of your choosing), and the Event notification endpoint URL provided by the support team in the pre-configuration steps.
- Click Validate and ensure that the status updated to Validated
- Click Add events, on the Event types dialog, under Meeting, select Start Meeting and End Meeting, click Done, and then click Save.
- Repeat steps 5 to 6, but instead of using the Meeting URL provided by the support team, instead use the Webinar URL, when choosing the event types please select Start Meeting and End Meeting under Webinar instead of Meeting.
- After adding both subscriptions, verify that the Event Subscriptions section is similar to that shown below.
- Navigate to the Activation page, and click Activate your app.
- Verify that the app is activated successfully.
Configuration - Part 4
You have now completed the configuration steps to enable us to configure Zoom integration. Please raise a support ticket to confirm that the app is activated and you are ready for us to enable the integration. We will confirm when this is complete and activated for your system.
Note: If you have more than one administration portal, you will need to repeat this process for each administration portal. The support team will be able to provide Event notification endpoint URLs for each administration portal.
Comments
0 comments
Please sign in to leave a comment.