Prerequisites for the Zoom integration
What you need before integrating Zoom: the online meeting module, a paid Zoom account, API credentials and an optional webhook token.
Before you can integrate Zoom with myschool, make sure of the following:
- The online meeting module is enabled for your school. If it isn’t, contact the myschool support team.
- The URL is activated in your school’s myschool site settings.
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-1.png- You have a Zoom account on the Pro plan or higher.
- Get your API Key and API Secret from the Zoom App Marketplace (see below).
- Get the Zoom Webhook Token from the Zoom App Marketplace (see below).
Note: The webhook token is optional. Set it up only if you want to record your meetings in the cloud and play them back later, or to get the list of participants who attended a meeting.
How to get the Zoom API Key and API Secret
- Go to the Zoom App Marketplace (
marketplace.zoom.us) and sign in with your Zoom account. - Go to Build App → JWT → App Credentials, and copy the API Key and API Secret.
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-2.pngHow to get the Zoom Webhook Token
- Go to the Zoom App Marketplace and sign in with your Zoom account.
- Go to Build App → JWT → Feature → Add new Event Subscription.
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-3.pngAdd the event subscriptions
- Click Add new Event Subscription.
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-4.png- Create two event subscriptions — one for recordings and one for the participant list:
| Subscription name | Event notification endpoint URL | Event type | Purpose |
|---|---|---|---|
| Recording completed Event | https://<your-school-domain>/online_meeting_rooms/recording_done_callback?meeting_target_type=zoom | Recordings → All Recordings have completed | Get the recordings of completed meetings |
| Meeting Ended | https://<your-school-domain>/online_meeting_rooms/meeting_ended_callback?meeting_target_type=zoom | Meeting → End Meeting | Get the participant list |
To get the recordings:
- Subscription name: Recording completed Event
- Event notification endpoint URL:
https://<your-school-domain>/online_meeting_rooms/recording_done_callback?meeting_target_type=zoom
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-5.png- Event type: Recordings → All Recordings have completed
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-6.pngTo get the participant list:
- Subscription name: Meeting Ended
- Event notification endpoint URL:
https://<your-school-domain>/online_meeting_rooms/meeting_ended_callback?meeting_target_type=zoom - Event type: Meeting → End Meeting
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-7.png- Copy the generated token. This is your Zoom Webhook Token.
Screenshot — to be added
public/images/articles/collaboration-zoom-prerequisites-8.pngThis enables cloud recording, so all your Zoom recordings can be accessed — provided you record the meeting.
Related articles
Was this article helpful?
Thanks for your feedback!