# Zoom
Zoom (opens new window) provides a cloud platform for video and audio conferencing, collaboration, chat, and webinars. Zoom is accessible across mobile devices, desktops, telephones, and room systems.
# How to connect to Zoom on Workato
# API version
The Zoom connector uses Zoom's REST API v2 (opens new window).
# Connection setup
The Zoom connector uses OAuth 2.0 to connect to Zoom. Follow these steps to create a Zoom connection in Workato:
Enter a Connection Name to identify your Zoom account in Workato.
Name your connection
Click Connect to initiate the authorization process. This action redirects you to Zoom's login page for login and verification.
Authorize your connection
# Permissions required to connect
We recommend that you set up a dedicated API user account in Zoom or create a custom OAuth profile to authorize Workato. This allows you to assign the API user to a role with only the necessary permissions. Alternatively, you can use an existing Zoom owner or admin account if you ensure it has the required permissions, as some admin accounts might have restricted access due to their specific configurations.
# Add an API user
Complete the following steps to set up a provisioned API user for Workato:
Navigate to Admin > User Management > Users in the Zoom sidebar.
Add users
Click the Add Users button.
Enter an appropriate email for the API user. An IT admin alias is recommended.
Enter user email
Choose Basic as the User Type. For fields like Department, Manager, Job Title, Location, and User Groups, enter N/A or make selections based on your requirements.
Navigate to Admin > Roles.
Add role
Select Add Role.
Provide a Role Name and Description.
Enter role name
Click Add.
Navigate to the Roles > Roles Settings tab and create a Zoom role with the following permissions for your integration:
- Users: View and Edit
- Role management: View and Edit
- Groups: View and Edit
- Recording management: View and Edit
- Zoom rooms: View and Edit
- Meetings: View
- Webinars: View
- Usage reports: View
- Schedule tracking fields: View and Edit
Create role permissions
Role permissions are required to allow the Workato Zoom connector to perform account-level actions, such as scheduling meetings or webinars on behalf of other Zoom users.
Select Save Changes to save the role permissions.
Navigate to Users and locate the user you created in the preceding steps.
Edit user role
Click Edit and assign the new User Role to your API user.
Assign user role
Click Save to confirm your changes.
# Create a custom OAuth profile
Complete the following steps to set up a custom OAuth profile for Workato:
Navigate to Tools > Custom OAuth profiles in Workato.
Click + New custom profile.
Select Zoom in the Application drop-down menu.
Enter a name for your custom OAuth profile in the Name field.
Click Create new app.
Create new app
Navigate to the Zoom App Marketplace (opens new window) and sign in to your Zoom account if you're not signed in already.
Click Develop > Build App.
Build app
Enter a name for your app.
Copy the Client ID and Client Secret and store both in a secure location. Both values are required in a future step.
Copy the Client ID and Client Secret
Enter https://www.workato.com/oauth/callback in the OAuth Redirect URL field.
OAuth Redirect URL
Optional. Configure other settings as required for your use case in the Access, Surface, and Embed tabs.
Navigate to Scopes and select + Add Scopes to add the required scopes.
Search for and select the required scopes for your connection. At minimum, Workato requires the View a user (user:read:user) scope to establish a successful connection.
Add scopes
Navigate to the Local Test tab and select Preview Your App Listing Page to ensure your settings are properly configured.
Navigate back to the New custom profile page in Workato and paste the Client ID and Client secret from the Zoom app setup to their respective fields.
Paste the client ID and client secret
Click Save.
Navigate to Projects > Connections and select Create > Connection.
Search for and select Zoom as your connection.
Enter a Connection name and select a Location for your connection.
Select your newly created OAuth profile in the Custom OAuth profile drop-down menu.
Click Connect.
Connect to Zoom using custom OAuth profile
Click Allow when prompted in the Zoom dialog box.
Enable the Zoom app
You have now established a successful Zoom connection in Workato. You may require additional scopes to fully use the Zoom triggers and actions in Workato.
# How to uninstall Workato from Zoom
UNINSTALLING ZOOM STOPS ACTIVE RECIPES USING THE CONNECTOR
Uninstalling Zoom automatically stops all active recipes that use the Zoom connector in your Workato account. You must establish a new app connection on Workato to reinstall Zoom.
Complete the following steps to uninstall Workato from Zoom:
Go to the Connections page in Workato and disconnect all active Zoom connections.
Visit the Zoom App Marketplace (opens new window), and sign in with your account administrator credentials.
Zoom App Marketplace
Click Manage and then select Added Apps in the navigation bar.
Remove apps
Find the app you plan to remove and select Remove. A Remove App window displays.
Optional. Use the drop-down menu to choose the reason for removing this app.
Confirm the app removal by clicking Remove.
# List of Workato triggers and actions
Workato supports the following triggers and actions:
- New event trigger (Trigger recipes of events in Meetings, Webinars, and more)
- Event actions (Webinar, meetings, and cloud recordings)
- Registration actions (Add, approve, or list registrants for your events)
- User actions (Add, remove, or update users in your Zoom organization)
- Download cloud recording files
Last updated: 6/20/2024, 5:28:16 PM