Zoom v2

Provides integration with Zoom, the video meetings and collaboration platform, through the Zoom REST API v2.

Use this Node to read and change Zoom data from a Workflow, for example to list users and their meetings, create or update meetings and webinars from incoming data, manage Team Chat channels, or read reports. The Node covers the Zoom Meetings, Users, Accounts, Team Chat and Rooms APIs.

Revision History

0.0.0.3 - Initial release.

Connection

Property Type Description
AuthenticationType Enum Server-to-Server OAuth (the default) for an account-level app, or OAuth for a user-level app that you authorize by signing in to Zoom.
AccountId String Account ID from your Server-to-Server OAuth app. Required for Server-to-Server OAuth.
ClientId String Client ID of your Zoom App Marketplace app.
ClientSecret Masked Client secret of your Zoom App Marketplace app.
AccessToken Masked Hidden. Managed by the Node.
AccessTokenExpiresAt DateTime Hidden. Managed by the Node.
RefreshToken Masked Hidden. Managed by the Node. Used only with OAuth.
TokenCredentialFingerprint Masked Hidden. Managed by the Node. Used only with Server-to-Server OAuth.
PendingAuthorization Masked Hidden. Managed by the Node. Used only with OAuth.
TimeoutSeconds Integer Timeout, in seconds, for each Zoom request, from 1 to 100. The default is 100.

Setup Notes

  1. In the Zoom App Marketplace, create the app that matches the authentication mode you want to use:
    • For Server-to-Server OAuth, create a Server-to-Server OAuth app. Copy its Account ID, Client ID and Client Secret.
    • For OAuth, create a user-level OAuth app. Copy its Client ID and Client Secret, and register the Flowgear OAuth callback URL as a redirect URL in the app.
  2. Add the scopes for the operations you plan to run to the Zoom app. Each template's description lists the scopes Zoom requires. The Connection test reads GET /users/me, so the app also needs a scope that reads users, for example user:read:user:admin.
  3. Create the Connection, select the AuthenticationType, and enter ClientId, ClientSecret and, for Server-to-Server OAuth, AccountId.
  4. For OAuth, authorize the Connection by signing in to Zoom. Until it is authorized, the Step fails with Sign in to Zoom first.
  5. Run the Connection test.

Sub-account management, Billing and SIP Connected Audio operations need a Zoom master account.

The Node runs on the Cloud Cluster only. For more about Clusters, see Runtime Cluster.

Methods

The Zoom Node groups Zoom's operations by HTTP method: Query runs GET operations, Create runs POST operations, Update runs PATCH and PUT operations, and Delete runs DELETE operations. Select a template so Flowgear fills in the OperationId and shows the matching Options and Items fields.

Query

Use Query to read Zoom records, for example to list users, list a user's meetings, read a meeting or read a report.

Parameter Type Description
Connection Connection The Zoom Connection.
OperationId String Identifier of the GET operation selected from a template.
Options Object Route and query values, using Zoom's parameter names, for example userId, meetingId or type.
Return Type Description
Response Array Zoom records, without a Flowgear object. A list returns one row per record. A list with no matches returns zero rows.

Create

Use Create to run Zoom POST operations, for example to create meetings, webinars, users or Team Chat channels, or add registrants.

Parameter Type Description
Connection Connection The Zoom Connection.
OperationId String Identifier of the POST operation selected from a template.
Items Array Required. One Zoom request per item: the request body fields plus, optionally, the item's own route values, for example userId.
Options Object Query values and fallback route values. Item route values override these.
Return Type Description
Response Array One row per item with Zoom's response fields and the Flowgear object with IsSuccess, Message and Request.

Update

Use Update to run Zoom PATCH and PUT operations, for example to update meetings, users or settings, or to change a meeting's status.

Parameter Type Description
Connection Connection The Zoom Connection.
OperationId String Identifier of the PATCH or PUT operation selected from a template.
Items Array Required. One Zoom request per item: the request body fields plus, optionally, the item's own route values, for example meetingId.
Options Object Query values and fallback route values. Item route values override these.
Return Type Description
Response Array One row per item with Zoom's response fields, if any, and the Flowgear object with IsSuccess, Message and Request.

Delete

Use Delete to delete or remove Zoom records, for example meetings, users or channel members.

Parameter Type Description
Connection Connection The Zoom Connection.
OperationId String Identifier of the DELETE operation selected from a template.
Items Array Required. One Zoom request per item, naming the record to delete through its route values, for example meetingId.
Options Object Query values and fallback route values. Item values override these.
Return Type Description
Response Array One row per item with any Zoom response fields and the Flowgear object with IsSuccess, Message and Request.

Usage Notes

  • Query templates set userId to me, so many read templates run as selected. Create, Update and Delete templates leave route values empty, so a new Step never acts on a record you did not name.
  • Paging is automatic, so do not set page_size, page_number or next_page_token in Options.
  • Each item can carry its own route values, such as meetingId or userId, so one Step can act on several records.
  • String and integer lists use comma-separated values (CSV), for example US,GB. Enclose values that contain commas in double quotes.
  • Free-form objects are shown as JSON text. Supply valid JSON text for these fields in Items.
  • Query errors fail the Step. A failed Create, Update or Delete item returns Flowgear.IsSuccess set to false with Zoom's message, and later items still run. A Zoom server error, a persistent rate limit, a timeout or an authentication failure fails the Step, and earlier items are already saved.
  • If the Step fails with Zoom denied access, add the scopes the operation needs to the Zoom app.

Known Issues

  • Zoom's list operations can lag a few seconds behind writes. When a Workflow checks its own changes, read the record by its ID or allow for the delay.
  • File uploads and downloads are not available, for example virtual backgrounds, user pictures, chat files and invoice downloads.
  • Master-account operations that repeat a standard operation for a sub-account, for example /accounts/{accountId}/users/..., are not available.
  • ZoomGov is not supported.
  • Zoom Phone, Contact Center, Mail, Calendar, Clips, Whiteboard, Scheduler and Video SDK APIs are not available.