Using Outgoing Webhook with Zoom

In order to make use of Zoom’s chat feature, you need to set up a chat app called Outgoing Webhooks that allows you to send information and receive notifications at the endpoints you specify.

Prerequisites for using Outgoing Webhook

• You should be familiar with the process of sending HTTP POST requests using a token and an endpoint

• In the Zoom App Marketplace, Outgoing Webhook Chat has been pre-approved for inclusion
  Note: Your Zoom administrator will be able to assist you if the app has not been pre-approved.

How to install Outgoing Webhook from the Zoom App Marketplace

1. Log in with your Zoom account to access the Zoom App Marketplace.

2. Search for Outgoing Webhook in the search box at the top right of your screen to locate the app on your device.

3. Find the Outgoing Webhook app in your search results and click on it to open it.

4. Add the item to your cart.

5. Click Authorize once you have confirmed that the app needs the permissions it requires.
   The Zoom Chat app will notify you once the process has been completed by sending you a notification.
   Note: The Zoom desktop client will automatically install the Outgoing Webhook chat app for you if your admin has installed it in the Zoom server.

How to use the Outgoing Webhook app

Configure the Outgoing Webhook app

1. Zoom’s desktop client can be accessed by signing in.

2. You will find the Chat tab on the left side of the screen.

3. Located under BOTS on the left side of the page, you will find the chatbot that handles incoming webhooks.
   It is also possible to access the chat channel of your choice.

4. Send a message by typing connect and sending it. If you navigated to a channel other than Outgoing, you will need to type the command /trigger connect if you navigated to another channel.
   A connection success message will be sent to you by the chat app and a link will be provided for you to configure the webhook.

5. The link can be found by clicking here.
   Upon opening the webpage, you will be presented with a number of settings that can be changed:

   • Channel Name: The channel in which you will be initiating the “connect” command will be this one.

   • Trigger Word(s): Select the commands that you would like your endpoints to receive from the command line. For example: The payload is set to send you a message that says “trigger do create ticket” which has the word “create ticket” in it.

   • URL(s): You will need to enter your trigger word commands (one per line) in order to receive them.

   • Token: There will be a token embedded in the payload of your endpoint that will be sent by Zoom. In order to verify whether the request originated from your Zoom chat, you can use this method.

   • Callback URL: In this scenario, triggers will be sent back to the Zoom chat channel in order to respond to them. The token along with this must be used in conjunction with each other

6. Please click on the Save button.

Send customized messages to Zoom Chat

If your system gets triggered, it will send a formatted message back to the user through Zoom chat in response to the trigger. A message in the chat app can be one of nine types, including a message, an action, a field, a select, an attachment, or a section.

As well as choosing the type of message you would like to send, you can also specify the style and functionality of your message. We encourage you to read our article on Customizing Messages on the Marketplace for more information.

Available commands

List all available commands

A list of commands is available by typing help in the 1:1 Outgoing Webhook chat channel or by typing /trigger help in your Zoom Chat channel.

New Connection

If you prefer to use Zoom Chat, type /trigger connect in your desired Zoom Chat group to generate a new connection via the 1:1 Outgoing Webhook chat channel or /connection in your desired Zoom Chat group. Create the configuration by clicking the link.

View Configurations

Configure [all] is the command to be typed into the 1:1 Outgoing Webhook chat channel or /trigger configure [all] to be typed into the Zoom Chat channel if you wish to receive a list of your configurations along with the link to modify each one.

Do Command

In the 1:1 Outgoing Webhook chat channel, you can type do + [your configured trigger words] + [Shift+Enter] + [Your desired text] or /trigger do + [your configured trigger words] + [Shift+Enter] + [Your desired text] to send a message and have the payload sent to your configured URLs by typing do + [your configured trigger words] + [Shift+Enter] + [Your desired text]. Data will be sent by the chat application.

Disconnect

In the 1:1 Outgoing Webhook chat channel, type disconnect or /trigger disconnect in the Zoom Chat channel that you wish to remove the subscription to remove the subscription for the current chat channel in the 1:1 Outgoing Webhook chat channel. To confirm, click the OK button.

Disconnect all subscriptions

To remove the subscription for the current chat channel, type /trigger disconnect all in your desired Zoom Chat channel or /trigger disconnect all in the 1:1 Outgoing Webhook chat channel in order to unsubscribe from that channel. To confirm, click the OK button.

How to uninstall the Outgoing Webhook chat app

1. The Zoom Marketplace can be accessed after logging into your Zoom account.

2. In the search results for Outgoing Webhook, select the app and click on it, or in the Manage section of the app list, click the Add Apps link within the app.

3. In the Outgoing Webhook section, click the Remove button.

4. Click on the Remove button after you have confirmed the dialog box.

The Zoom support team is available to provide additional assistance if needed.