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.
  • Create Channel: create a new channel in Zoom using the inputs to construct the channel name, owner and permission settings for channel members.
  • Post Message: post a message to an existing Zoom channel.
  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

Agenda

agenda

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

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.

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.

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).

Outputs

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

Label

API mapping

Description

Agenda

agenda

The description or agenda of the meeting. {agenda}

Join URL

join_url

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

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}

 

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}

Create Channel

Use the Create Channel step to automatically create a new channel in Zoom . Map outputs from previous steps to construct the channel properties.

Inputs

Inputs with an asterisk* are required.

Label

API mapping

Description

Add Member Permission

channel_settings. add_member_permissions

Whether new members are added by anyone or only administrators. Available options are: 

  • All: anyone can add members to private channels.
  • Admins: only administrators can add new members to private channels.

The default value is 'All'.

Channel Name

name

Name of the Zoom channel with a maximum length of 256 characters. Longer values will be truncated.

Members

members[].email

Comma separated list of up to 20 user email addresses to add as members of the channel. Longer lists will be truncated.

Mention All Permission

channel_settings.mention_all_permissions

Set who can use @all mention in the channel. Available options are:

  • All: anyone can use the mention command in the channel.
  • Admins: only administrators can use the mention command in the channel.
  • None: no one can use the mention command in the channel.

The default value is ‘All’.

Owner

The Email address or unique identifier (UUID) of the user that owns the channel. If left blank, the credentials of the user who authenticated the Zoom endpoint are used.

Posting Permission

channel_settings.posting_permissions

Set who can post messages to the channel. Available options are: 

  • All: anyone can post messages to the channel.
  • Admins: only the channel owner and administrators can post messages.
  • Limited: only the channel owner, administrators, and certain members can post to the channel.

The default value is ‘All’.

Shared Space

shared_space

Case-sensitive name or ID of the shared space to create the channel in.

Type

type

Type of channel to create. Available options are:

  • Private: members must be invited to join the channel
  • Public: members can join the channel without being invited by an owner or administrator.

The default value is ‘Public’, however when the channel is associated with a shared space the default value is ‘Private’.

View Previous Message Files

channel_settings.new_members_can_see_previous_message_files

Whether or not new members can see all previous messages in the channel when they join. Available options are:

  • true: members can see all previous channel messages and files.
  • false: members only see messages from the point they join the channel.

Default value is ‘true’.

Outputs

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

Label

API mapping

Description

Channel ID

id

Unique ID of the channel.

Channel Name

name

Name of the Zoom channel.

Channel URL

channel_url

Direct URL to the Zoom channel. This URL can be used to invite users to private channels.

JID

jid

Unique identifier used by a Zoom app or chatbot to interact with a specific chat channel.

Result

Result returned by Zoom. Available options are:

  • Success
  • Failure

Type

type

The type of channel created.

Post Message

Use the Post Message step to automatically post a message to a Zoom channel. Map outputs from previous steps to construct the meeting properties.

Inputs

Inputs with an asterisk* are required.

Label

API mapping

Description

Channel

to-channel

Name or ID of the channel to post the message in.

User

userId

Email or unique identifier (UUID) of the user to post the message as. If left blank, the credentials of the user who authenticated the Zoom endpoint are used.

Message

message

The text of the message to post. Use basic HTML to format and add links to the message content. For more detailed formatting information, see the online help.

Reply to ID

reply_main_message_id

To add the message as a reply to an existing one, enter the Message ID of the top-level message.

Scheduled Time

scheduled_time

The scheduled time to send the message in yyyy-MM-dd'T'HH:mm:ss'Z' format. Minimum value is 30 minutes from the current time. Maximum value is 180 days from the current time.

Outputs

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

Label

API mapping

Description

Message 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}

Channel ID

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

 

Result

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

Text formatting

Zoom allows certain text formatting options for messages posted to a channel. You can set the message background color, text color, text size, and other paragraph formatting using HTML. While Zoom might allow additional formatting, the options listed here are verified to work with Flow Designer. The following code sample displays all available formatting options.

<h1>This is an example Zoom message using HTML formatting</h1><br>

<b>It supports:</b><br>

<ol>

<li>Plain text messages</li>

<li>Formatted messages</li>

</ol> <br>

<br> <b>Supported formatting:</b><br>

<ul>

<li><b>Bold</b></li>

<li><i>Italic</i></li>

<li><s>Strike Through</s></li>

<li><u>Underline</u></li>

<li><p style="color:red">Font Color</p></li>

<li><p style="background-color:yellow">Font background color</p></li>

<li><p style="size:s">Font size</p></li>

<li><a href="https://xmatters.com">Links</a></li>

<li>Mentions like <a href="mention:you@your-company.com">your name</a></li>

</ul><br>

<br><p>If you enter a 'br' tag, it becomes a line break</p><br>

<q>You can even quote text.</q>

Detailed information on the formatting options is available in the following drop-down.

The following HTML formatting is available for messages in Zoom channels.

Options

 Description

Text

Use the following HTML tags to apply text formatting to your Zoom message: 

  • <b></b>: bold
  • <i></i>: italics
  • <s></s>: strikethrough
  • <q></q>: quote
  • <u></u>: underline
Paragraph

Use the following HTML tags to apply paragraph formatting to your Zoom message. 

  • <p></p>:paragraph
  • <p style=""></p>: paragraph style for specifying font size, color, and background color.
  • <br>: line breaks
Font Size

You can set the font size of your message in Zoom. The available options are: 

  • s: small font size
  • m: medium font size
  • l: large font size

Example: <p style="size:s">Font size</p>

Font Color

You can add the following font colors to a Zoom channel message:

  • red
  • orange
  • yellow
  • green
  • blue
  • purple
  • pink

Example: <p style="color:red">Font Color</p>

Background Color

The following background colors are available: 

  • red
  • orange
  • yellow
  • green
  • blue
  • purple
  • pink

 

Example: <p style="background-color:yellow">Font background color</p>
List

The following list formatting options are available: 

  • <ol></ol>:ordered list
  • <ul></ul>: bulleted list
  • <li></li>: list items
Reference

The following reference tags are available: 

  • <a href=""></a>: links, such as web sites
  • <a href="mention:"></a>: notify a specific person using their email address
  • <a href="mention:all"></a>: notify everyone in the channel

Examples: 

<a href="https://xmatters.com">xMatters</a>

<a href="mention:mmcbride@your-company.com">Mary </a>

<a href="mention:all">Everyone</a>

 
Header

Heading tags are available for levels 1 through 6: 

  • <h1></h1>: heading level 1