Zoom [v2]

The Zoom modules enable you to monitor, create, update, retrieve, delete meetings and webinars, or manage meeting and webinars registrants, or manage cloud recordings, phone calls, and chats in your Zoom account.

• See the changelog between Zoom [v2] and Zoom [v1]

Getting Started with Zoom

Prerequisites

• A Zoom account — you can create one at zoom.us/signup.

Connecting Zoom to Integromat

1. Go to Integromat and open the Zoom module's Create a connection dialog.

2. Enter a name for the connection to the Connection name field and click Continue.

After you click the Continue button, Integromat will redirect you to the Zoom website where you will be prompted to grant Integromat access to your account.

3. Confirm the dialog by clicking the Authorize button.

The connection has been established. You can proceed with setting up the module.

Meeting

Watch Meetings

Triggers when a specified meeting event occurs.

Webhook name	Enter the name for the webhook, e.g. Participant Joined
Connection	Establish a connection to your Zoom account.
Trigger by specific events	Enable this option to select specific events (below) you want to trigger the module. Disable this option to trigger the module when any of the meeting events occurs.
Events	Select events that will trigger the Watch Meetings module.

Now, every time the specified events occur, the Watch Meetings module in your Integromat scenario is triggered.

Create a Meeting

Creates a meeting for a user.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who creates the meeting.
Topic	Enter a topic or name for your meeting.
Type	Select the meeting type.
Use Personal Meeting ID	Enable this option to use Personal Meeting ID instead of an automatically generated meeting ID. It can only be used for scheduled meetings, instant meetings, and recurring meetings with no fixed time.
Start Time	Enter the start date and time for your meeting. You can start your meeting at any time before the scheduled time. See the list of supported date and time formats.
Duration in Minutes	Enter the duration of the meeting (in minutes). For scheduled meetings only.
Join Before Host	Select the Yes option to allow participants to join the meeting before the host starts the meeting. Only for scheduled or recurring meetings.
Recurrence	Set up the meeting recurrence. Type Select the recurrence meeting type. Repeat Interval Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as `2` and the value of the Type parameter as Monthly. For a Daily meeting, the maximum interval you can set is `90` days. For a Weekly meeting the maximum interval that you can set is of `12` weeks. For a Monthly meeting, there is a maximum of `3` months. End Type Number of Occurrence – Enter how many times the meeting should recur before it is canceled to the End Times field below.  Specific Date – Enter the final date on which the meeting will recur before it is canceled to the End Date Time field below. See the list of supported date and time formats. Weekly Days Select days in a week when the monthly meeting should recur. Repeat Type Day in a Month – Define which day in a month, the meeting should recur in the Monthly Day field below. The value range is from 1 to 31. Weekday in a Month – Define which day(s) of the week the meeting should repeat in the Monthly Week field below. The value for this field could be a number between 1 to 7.
Registration Type	Select the type of attendees registration
Schedule for User ID or Email	Enter the email address or Zoom User ID to schedule this meeting for someone else in your account.
Password	Define the passcode to join the meeting. By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.
Agenda	Enter the meeting description.

Get a Meeting

Retrieves meeting details.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to retrieve details for.
Occurrence ID	Enter (map) or select the occurrence to retrieve details of the recurring meeting.
Show Previous Occurrences	Select the Yes option to retrieve meeting details of all previous occurrences of a recurring meetings.

List Meetings

Retrieve meetings in your Zoom account.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Category	Select the type of meeting: Scheduled - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of Previous Meetings and Upcoming Meetings displayed in the user's Meetings page on the Zoom Web Portal. Live - All the ongoing meetings. Upcoming - All upcoming meetings including live meetings.
Limit	Set the maximum number of meetings Integromat will return during one execution cycle.

Update a Meeting

Updates an existing meeting.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to update.

Please find the descriptions of the fields in the Create a Meeting section above.

End a Meeting

Updates the status of a meeting.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to end.

Delete a Meeting

Deletes a meeting

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to delete.
Occurrence ID	Enter (map) the meeting occurrence ID to remove a single occurrence.
Schedule for Reminder	Select the Yes option to notify the host and alternative host about the meeting cancellation via email.

Add a Meeting Registrant

Registers a participant for a meeting.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to register the participant to.
Occurrence IDs	Enter (map) the meeting occurrence ID of the occurrence(s) where to register the participant to.
Email	Enter a valid email of the registrant.
First Name	Enter the first name of the registrant.
Last Name	Enter registrant's last name.

List Meeting Registrants

Retrieves all meeting registrants.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to retrieve registrants for.
Occurrence IDs	Enter (map) the meeting occurrence ID of the occurrence to retrieve registrants for.
Status	Select the registrant status to filter results by. Pending - Registrant's status is pending. Approved - Registrant's status is approved. Denied - Registrant's status is denied.
Limit	Set the maximum number of registrants Integromat will return during one execution cycle.

Update Meeting Registrants Status

Updates registrant status for a meeting.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Meeting ID	Enter (map) or select the meeting you want to update registrants for.
Occurrence IDs	Enter (map) the meeting occurrence ID of the occurrence to update registrants for.
Status	Set the status for the meeting registrants (specified below). Pending - Registrant's status is pending. Approved - Registrant's status is approved. Denied - Registrant's status is denied.
Registrants	Specify registrants whose status you want to update.

Webinar

Watch Webinars

Triggers when a specified webinar event occurs.

Webhook name	Enter the name for the webhook, e.g. Webinar Created or Updated
Connection	Establish a connection to your Zoom account.
Trigger by specific events	Enable this option to select specific events (below) you want to trigger the module. Disable this option to trigger the module when any of the webinar events occurs.
Events	Select events that will trigger the Watch Webinars module.

Now, every time the specified events occur, the Watch Webinars module in your Integromat scenario is triggered.

Create a Webinar

Creates a webinar for a user.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who creates the webinar.
Topic	Enter a topic or name for your webinar.
Type	Select the meeting type.
Start Time	Enter the start date and time for your webinar. You can start your webinar at any time before the scheduled time. See the list of supported date and time formats.
Duration in Minutes	Enter the duration of webinar (in minutes). For scheduled webinars only.
Recurrence	Set up the webinar recurrence. Type Select the recurrence webinar type. Repeat Interval Define the interval at which the webinar should recur. For instance, if you would like to schedule a webinar that recurs every two months, you must set the value of this field as `2` and the value of the Type parameter as Monthly. For a Daily meeting, the maximum interval you can set is `90` days. For a Weekly meeting the maximum interval that you can set is of `12` weeks. For a Monthly webinar, there is a maximum of `3` months. End Type Number of Occurrence – Enter how many times the webinar should recur before it is canceled to the End Times field below.  Specific Date – Enter the final date on which the webinar will recur before it is canceled to the End Date Time field below. See the list of supported date and time formats. Weekly Days Select days in a week when the monthly webinar should recur. Repeat Type Day in a Month – Define which day in a month, the webinar should recur in the Monthly Day field below. The value range is from 1 to 31. Weekday in a Month – Define which day(s) of the week the webinar should repeat in the Monthly Week field below. The value for this field could be a number between 1 to 7.
Registration Type	Select the type of attendees registration.
Password	Define the passcode to join the meeting. By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.
Agenda	Enter the webinar description. Max. 2000 characters.

Get a Webinar

Retrieves webinar details.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to retrieve details for.
Occurrence ID	Enter (map) or select the occurrence to retrieve details of the recurring webinar.
Show Previous Occurrences	Select the Yes option to retrieve webinar details of all previous occurrences of a recurring webinar.

List Webinars

Retrieve webinars in your Zoom account.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Limit	Set the maximum number of webinars Integromat will return during one execution cycle.

Update a Webinar

Updates an existing webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the meeting.
Webinar ID	Enter (map) or select the webinar you want to update.

Please find the descriptions of the fields in the Create a Webinar section above.

Delete a Webinar

Deletes a webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to delete.
Occurrence ID	Enter (map) the webinar occurrence ID to remove a single occurrence.

Add a Webinar Registrant

Registers a participant for a webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to register the participant to.
Occurrence IDs	Enter (map) the meeting occurrence ID of the occurrence(s) where to register the participant to.
Email	Enter a valid email address of the registrant.
First Name	Enter the first name of the registrant.
Last Name	Enter registrant's last name.

List Webinar Registrants

Retrieves all webinar registrants.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to retrieve registrants for.
Occurrence IDs	Enter (map) the webinar occurrence ID of the occurrence to retrieve registrants for.
Status	Select the registrant status to filter results by. Pending - Registrant's status is pending. Approved - Registrant's status is approved. Denied - Registrant's status is denied.
Limit	Set the maximum number of registrants Integromat will return during one execution cycle.

Update Webinar Registrant Status

Updates registrants status for a webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to update registrants for.
Occurrence IDs	Enter (map) the webinar occurrence ID of the occurrence to update registrants for.
Status	Set the status for the webinar registrants (specified below). Pending - Registrant's status is pending. Approved - Registrant's status is approved. Denied - Registrant's status is denied.
Registrants	Specify registrants whose status you want to update.

Add Webinar Panelist

Registers panelists for a webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to register a panelist for.
Panelist	Enter  the person's name and email to add the panelist.

List Webinar Panelist

Retrieves a list of the panelist of a webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to list panelists for.
Limit	Set the maximum number of panelists Integromat will return during one execution cycle.

Remove a Webinar Panelist

Removes a panelist from a webinar.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Webinar ID	Enter (map) or select the webinar you want to remove the panelist from.
Panelist ID	Enter (map) the ID of the panelist you want to remove from the webinar.

Cloud Recording

Watch Recordings

Triggers when a specified recording event occurs.

Webhook name	Enter the name for the webhook, e.g. Recording Started
Connection	Establish a connection to your Zoom account.
Trigger by specific events	Enable this option to select specific events (below) you want to trigger the module. Disable this option to trigger the module when any of the recording event occurs.
Events	Select events that will trigger the Watch Recordings module.

Now, every time the specified events occur, the Watch Recordings module in your Integromat scenario is triggered.

List Cloud Recordings

Returns cloud recordings from a webinar or a meeting.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the recording.
Start Date	Enter the start date and time from which you want to filter results. See the list of supported date and time formats.
End Date	Enter the end date and time to which you want to filter results. See the list of supported date and time formats.
List Recordings from Trash	Enable this option to retrieve recordings from the trash.
Limit	Set the maximum number of recordings Integromat will return during one execution cycle.

Download a Cloud Recording

Downloads a cloud recording (as an MP4 file).

Connection	Establish a connection to your Zoom account.
Download URL	Enter (map) the download URL of the recording. It can be mapped from the List Cloud Recordings module.
Download Token	Enter the token if needed.
File Name	Enter the file name.

Delete a Cloud Recording

Deletes a webinar or meeting recording.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the webinar.
Meeting ID	Enter (map) or select the meeting you want to delete the recording from.
Recording ID	Enter (map) the ID of the recording you want to delete.

Phone Call

Watch Phone Calls

Triggers when a specified phone call event occurs.

Webhook name	Enter the name for the webhook, e.g. Caller Connected
Connection	Establish a connection to your Zoom account.
Event Type	Select the type of event.
Events	Select events that will trigger the Watch Phone Calls module.

Now, every time the specified events occur, the Watch Phone Calls module in your Integromat scenario is triggered.

List Phone Numbers

Retrieves all Zoom Phone numbers in a Zoom account based on filter settings.

Type	Filter the result by type: Assigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. Unassigned: The number is not assigned to anyone.
Extension Type	Select the type of assignee to whom the number is assigned.
Number Type	Select the type of phone number.
Include Pending Numbers	Select the Yes option to include pending numbers in the response.
Site ID	Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site.
Limit	Set the maximum number of phone numbers Integromat will return during one execution cycle.

List Call Logs

Retrieves a user’s call logs.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID of the user who created the phone call.
Start Date	Enter the start date of the date range. Should only be one month as the report includes only one month worth of data at once. See the list of supported date and time formats.
End Date	Enter the end date of the date range. Should only be one month as the report includes only one month worth of data at once. See the list of supported date and time formats.
Only show missed calls	Enable this option to retrieve return missed calls only.
Limit	Set the maximum number of call logs Integromat will return during one execution cycle.

Chat

Watch Chat Channels

Triggers when a specified chat channel event occurs.

Webhook name	Enter the name for the webhook, e.g. Member Joined
Connection	Establish a connection to your Zoom account.
Event Type	Select the type of event.
Events	Select events that will trigger the Watch Chat Channels module.

Now, every time the specified events occur, the Watch Chat Channels module in your Integromat scenario is triggered.

Watch Chat Messages

Triggers when a specified chat message is sent, updated, replied, or deleted.

Webhook name	Enter the name for the webhook, e.g. Message Sent
Connection	Establish a connection to your Zoom account.
Event Type	Select the type of event.
Events	Select events that will trigger the Watch Chat Messages module.

Now, every time the specified events occur, the Watch Chat Messages module in your Integromat scenario is triggered.

Send a Chat Message

Sends a message to the chat channel or the contact.

Connection	Establish a connection to your Zoom account.
User ID	Select the user or enter the ID.
Target	Select whether to send a message to the channel to the particular contact.
Email Address of the Contact	Enter the email address of the contact you want to send the message to. You can use the Search button () to find the  desired contact.
Channel ID	Enter (map) the channel ID or select the channel you want to send the message to.
Message	Enter the content of the message.

Other

Make an API Call

Allows you to perform a custom API call.

Connection	Establish a connection to your Zoom account.
URL	Enter a path relative to https://api.zoom.us. or example: /v2/users/me For the list of available endpoints, refer to the Zoom API Documentation.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we added those for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - List Users

The following API call returns all users in your Zoom account:

URL:
/v2/contacts

Method:
GET

The result can be found in the module's Output under Bundle > Body > contacts. 
In our example, 2 contacts were returned:

Uninstallation Integromat App from a Zoom Account

1. Log in to your Zoom account and navigate to the Zoom App Marketplace.

2. Click Manage (top-right corner) > Installed Apps.

3. Click Uninstall button for the Integromat app.

Changelog