Zoom steps

Flow Designer has a built-in step to help you integrate Zoom meetings into your incident response and critical event management flows.

The following step is available:

  • Create Meeting: create a new Zoom meeting, using properties to construct the meeting topic and agenda.

In the example above, a flow initiates an incident in xMatters based on a person's response to a notification, then creates a Jira Cloud issue with information from the alert and the incident. It then creates a Zoom meeting, using information from the source system, xMatters incident, and Jira Cloud Issue in the meeting topic and agenda.

  1. To add a Zoom step to your flow, go to the Apps panel in the palette, expand the Zoom section, and drag the step onto the canvas.
  2. Connect the step to the previous step in the flow. This lets you access alert properties and outputs of previous steps when configuring this step's inputs.
  3. Double-click the step to edit it, and use the Setup tab to configure the inputs. You can use plain text and input variables (or both). See the Creating Meeting section below for detailed information on the inputs for this step, including which inputs are required.
  4. On the Endpoint tab, configure the step to point to your Zoom Server-to Server OAuth app.

Create Meeting

Use the Create Meeting step to automatically create a new Zoom meeting. Map outputs from previous steps to construct the meeting properties.

Inputs

Inputs with an asterisk* are required.

Label

API mapping

Description

Schedule For*

schedule_for

Sets whether another user on the same Zoom account can act as the meeting host. Provide the Zoom user ID or email address of the user (they must have schedule privilege).

Topic*

topic

The topic of the meeting to be created; also used as the meeting name. You can use a mixture of plain text and mapped inputs (for example, mapping a ticket ID or the name of a targeted group).

Agenda

agenda

The description or agenda of the meeting. You can use a mixture of plain text and mapped inputs.

Join before host

join_before_host

This specifies whether guests can join the meeting before the host. If true, the waiting room is disabled and guests can join before the host. If false, this setting is disabled and guests must wait for the host to join. If this input is empty, the default setting of the user specified in the 'Schedule For' input is used.

Automatic recording

auto_recording

Sets whether the meeting is automatically recorded and where to store the recording:

  • cloud: the meeting is recorded and stored to the cloud

  • local: the meeting is recorded and stored on the host's computer

  • none: the meeting is not recorded

If empty, the default setting of the user specified in the 'Schedule For' input is used.
Incident ID Associates the meeting with an incident in xMatters, adding it as a collaboration channel. For more information on adding collaboration channels, see the incident resolution workflow guide, or learn about incident management in xMatters.

Outputs

These outputs are available as inputs to steps further along the flow.

Label

API mapping

Description

Meeting ID

id

The ID of the meeting in Zoom. You could send this back to another system (for example, to record the meeting ID in a ticket, linking it in your system of record). {id}

Passcode

password

The passcode that's required to join or start the meeting. {password}

 

Join URL

join_url

The link guests can use to join the meeting. {join_url}

Start URL

start_url

The link the host can use to start the meeting. {start_url}

Topic

topic

The topic of meeting. If you associated the meeting with an incident, this is also the name for the meeting that appears in the Collaboration section of the Incident Console.{topic}

Agenda

agenda

The description or agenda of the meeting. {agenda}