Zoom

1. Overview

Zoom is a leading cloud-based video communications platform that provides video and audio conferencing, chat, and webinar services across mobile devices, desktops, telephones, and room systems.

The GoInsight Zoom node allows you to seamlessly integrate meeting management into your automated workflows. It empowers you to perform the complete lifecycle of meeting operations without leaving the GoInsight platform, including:

• Creating new meetings with detailed scheduling and security settings.
• Retrieving information about existing meetings.
• Updating the details of a scheduled meeting.
• Deleting meetings that are no longer needed.

2. Prerequisites

• Before using this node, you must have a valid Zoom account.
• You will need sufficient permissions within your Zoom account to create and manage API credentials (typically requiring an administrator or developer role).

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

This node is designed to manage meeting resources within your Zoom account. The following table summarizes the available operations.

Summary

Operation Details

Create a Meeting

Creates a new Zoom meeting with customizable settings including topic, agenda, start time, duration, and security options like password and waiting room.

Options:

• Topic: Meeting topic/title
• Agenda: Meeting agenda/description
• StartTime: Meeting start time in ISO format (YYYY-MM-DDTHH:MM:SSZ)
• Duration: Meeting duration in minutes
• TimezoneStr: Timezone identifier
• Password: Meeting password
• WaitingRoom: Enable waiting room
• JoinBeforeHost: Allow participants to join before host
• MuteUponEntry: Mute participants when joining

Output:

• MeetingId (string): Unique identifier of the created meeting
• JoinUrl (string): URL for participants to join the meeting
• StartUrl (string): URL for the host to start the meeting
• MeetingNumber (string): Meeting number that participants can use to join
• Password (string): Meeting password for security
• StartTime (string): Scheduled start time of the meeting
• Duration (number): Duration of the meeting in minutes
• Topic (string): Topic or title of the meeting
• Agenda (string): Meeting agenda or description
• StatusCode (number): HTTP status code indicating operation result
• ErrorMessage (string): Error message if operation failed

Delete Meeting

Deletes one or more Zoom meetings specified by their meeting IDs, with optional parameters for recurring meetings and participant notifications.

Options:

• MeetingId: Meeting ID or comma-separated list of meeting IDs to delete
• OccurrenceId: Occurrence ID for recurring meetings (optional)
• NotifyRegistrants: Whether to notify registered participants

Output:

• AllDeleted (bool): Whether all meetings were successfully deleted
• FailedItems (string-array): List of meetings that failed to be deleted
• StatusCode (number): HTTP status code indicating operation result
• ErrorMessage (string): Error message if operation failed

Get Meeting

Retrieves detailed information for one or more Zoom meetings specified by their meeting IDs, with optional parameters for recurring meetings.

Options:

• MeetingId: Meeting ID or comma-separated list of meeting IDs to retrieve
• OccurrenceId: Occurrence ID for recurring meetings (optional)
• ShowPreviousOccurrences: Whether to show previous occurrences of recurring meetings

Output:

• AllRetrieved (bool): Whether all meetings were successfully retrieved
• Meetings (string-array): List of retrieved meeting information
• FailedItems (string-array): List of meetings that failed to be retrieved
• StatusCode (number): HTTP status code indicating operation result
• ErrorMessage (string): Error message if operation failed

Update a Meeting

Updates an existing Zoom meeting with optional parameters including topic, agenda, timing, and security settings. Only provided fields will be updated.

Options:

• MeetingId: Meeting ID to update
• Topic: Meeting topic/title to update
• Agenda: Meeting agenda/description to update
• StartTime: Meeting start time in ISO format (YYYY-MM-DDTHH:MM:SSZ)
• Duration: Meeting duration in minutes
• TimezoneStr: Timezone identifier
• Password: Meeting password
• WaitingRoom: Enable waiting room
• JoinBeforeHost: Allow participants to join before host
• MuteUponEntry: Mute participants when joining
• OccurrenceId: Occurrence ID for recurring meetings (optional)

Output:

• MeetingId (string): Unique identifier of the updated meeting
• UpdatedFields (string): JSON string of fields that were updated
• StatusCode (number): HTTP status code indicating operation result
• ErrorMessage (string): Error message if operation failed

5. Example Usage

This section will guide you through creating a simple workflow to schedule a new meeting in your Zoom account. The workflow will consist of a Start node, a Zoom node to create the meeting, and an Answer node to display the result.

1. Add the Zoom Node

• In the workflow canvas, click the + button to add a new node.
• In the pop-up panel, select the "Tools" tab.
• Find and select "Zoom" from the list of tools.
• From the list of supported operations for Zoom, click on "Create a Meeting". This will add the node to your canvas.

2. Configure the Node

• Click on the newly added "Create a Meeting" node to open its configuration panel on the right.
• Credentials: At the top of the panel, find the credentials field. Click the dropdown menu and select your pre-configured Zoom credential.
• Parameters: Customize your meeting by filling in the following optional fields.
  • Topic: Enter a title for your meeting, for example, Weekly Team Sync.
  • Agenda: Provide a brief description, such as Discussing project milestones for the week.
  • StartTime: Specify the start time in ISO 8601 format. For example, to schedule it for October 26, 2024, at 2 PM UTC, you would enter 2024-10-26T14:00:00Z.
  • Duration: Enter the meeting length in minutes, for example, 60.
  • Password: For added security, you can set a password like ProjectX2024!.

3. Run and Verify

• Once the parameters are configured, any error indicators on the workflow canvas should disappear.
• Click the "Run" button in the top-right corner of the canvas to execute the workflow.
• After a successful run, you can click the logs icon in the top-right corner to view the detailed inputs and outputs of the node, confirming that the meeting was created and retrieving its JoinUrl and MeetingId.

After completing these steps, your workflow is fully configured. When executed, it will automatically create a new meeting in your Zoom account with the specified details.

6. FAQs

Q: My request failed with a 401 Unauthorized or 403 Forbidden error. What should I do?

A: This typically indicates an issue with your credentials or permissions. Please check the following:

• Ensure your API Key and Secret are correctly entered in the GoInsight credentials configuration.
• Verify that the API user or app in your Zoom account has the necessary scopes and permissions to create and manage meetings.

Q: How do I correctly format the StartTime parameter?

A: The StartTime parameter requires the date and time to be in ISO 8601 format. The standard format is YYYY-MM-DDTHH:MM:SSZ. The Z at the end signifies UTC (Coordinated Universal Time). For example, 2024-12-01T10:30:00Z represents December 1st, 2024, at 10:30 AM UTC.

Q: Can I use these actions to manage recurring meetings?

A: The OccurrenceId parameter in the Delete, Get, and Update actions allows you to specify a particular instance of a recurring meeting. However, creating a recurring meeting series requires more complex parameters not directly exposed in the Create a Meeting action. For advanced scheduling, please refer to the official Zoom API documentation.

7. Official Documentation

For more detailed information about all available API endpoints and advanced features, please consult the Zoom Official API Documentation.