How to use the outbound webhook with Zoom
You can send information about Zoom’s chat app through the Outgoing Webhook chat app and receive notifications on your specified endpoints depending on the information sent.
The following topics are covered in this article:
- How to install outbound webhook from the Zoom App Marketplace
- How to use the outgoing webhook app
- Configure the outgoing webhook app
- Send custom messages to Zoom Chat
- Available Commands
- How to uninstall outbound webhook chat app
Requirements for using outbound webhook
- A good understanding of how a token is used with HTTP POST requests and what the endpoints are
- It has been approved for inclusion in the Zoom App Marketplace for the outbound webhook chat app
Note: Your Zoom administrator can help you if the app isn’t pre-approved.
How to install outbound webhook from the Zoom App Marketplace
- You must sign in with your Zoom account to access the Zoom App Marketplace.
- To find Outgoing Webhook in your Google Play Store, simply type “Outgoing Webhook” in the search box at the top right of your screen.
- The outgoing webhook app can be found in your search results by clicking on it in your search results.
- Add the item to your cart by clicking the Add button.
- Please confirm that the app needs the requested permissions and then click the Authorize button.
Once the process is complete, a Zoom chat notification will be sent to you directly from the chat application.
Note: You can automatically use the outgoing webhook chat application on your Zoom desktop client if your admin installed it.
How to use the outgoing webhook app
Configure the outgoing webhook app
- Sign in to your account using the Zoom desktop application.
- The Chat tab can be found by clicking on it.
- On the left, under BOTS, is an outgoing webhook chatbot.
Also, you can choose the chat channel you want to use. - Click the Connect button and send the message. You must type /trigger connect if you don’t see the outgoing message in the chat channel but navigated to another.
In response to your request, the chat app will provide a connection success message, along with a link that allows you to configure the webhook. - Please click on the following link for more information.
Once the page opens, you’ll have the option to change a variety of settings, including:- This channel has the following names:
- If you have already initiated the connect command on this channel, you can also see it on this channel.
- The trigger words are as follows:
- Please specify what commands are sent to your endpoints so they can get the information from you. Let’s take the following example as an example:
- There is a trigger that initiates the ticket creation process. You get this trigger as “trigger_word” in the payload of the email.
- URL(s):
- To get trigger word commands for your endpoints (one per line), type the endpoints (one per line) in the text box.
- Sign:
- Zoom sends the token to your endpoint in the payload, which contains information about your endpoint. To make sure the request came from your Zoom chat, you can use this to verify it.
- When calling back, the following URL is used:
- The Zoom chat channel is notified when triggers are sent back and is used to respond to those triggers. The token and this document must be used together for it to work
- Save the changes by clicking the Save button.
Send custom messages to Zoom Chat
When your system is triggered, your system can respond by sending your user a formatted message over Zoom chat in response to the trigger. A number of message types are available in the chat app, including Messages, Actions, Fields, Choices, Attachments, and Sections.
Aside from choosing the type of message you want to send, you can further customize your message by specifying the style and functionality you want to use. For more information, see our article on customizing messages in the marketplace.
Available Commands
List all available commands
For a list of all available commands, type help in the Zoom chat channel of your choice or /trigger help in the 1:1 Outgoing Webhook chat channel.
New connection
Connect can be generated by entering the connect command in the 1:1 Outgoing Webhook chat channel or by using the /trigger connect command in the Zoom chat channel you wish to initiate the connection from. The configuration can be created by clicking on the link provided.
View configurations
In the 1:1 outgoing webhook chat channel, enter configure [all] or configure /trigger [all] in any desired Zoom chat channel to get a list of your configurations with an edit link for each so you can change the settings.
execute order
There are two ways you can trigger your incoming message using do + [your configured trigger words] + [Shift+Enter] + [Your desired text] in 1:1 outgoing webhook chat channel or by adding /trigger do + [your configured trigger words] + [Shift+Enter] + [Your desired text] in your favorite Zoom chat channel to trigger your incoming message and have the payload sent to the URLs you configured. You can send data through the chat app.
Separate
There are two ways to remove your subscription from the 1:1 Outgoing webhook chat channel. The first is to type disconnect in the 1:1 Outgoing Webhook chat channel, or type /trigger disconnect if you want to unsubscribe from Zoom Chat. Click the OK button at the bottom of the screen to confirm.
Disconnect all subscriptions
To unsubscribe from the current chat channel, in your desired Zoom chat channel, type /trigger disconnect all to unsubscribe from the current incoming webhook chat channel, or type in the 1:1 Outgoing webhook chat channel all disconnect one. Confirm your decision by clicking the OK button.
How to uninstall outbound webhook chat app
- If you wish to access the Zoom Marketplace, you should log into your Zoom account.
- If you’re looking for Outgoing Webhook, you can either search for the app and click it, or click Manage, then click the Add apps link and navigate to your installed apps.
- The outgoing webhook can be removed by clicking the Remove button next to it.
- Click the Remove button after confirming the dialog box.