You can send information through Zoom’s chat app via the Outgoing Webhook chat app and you can receive notifications at your specified endpoints based on what information has been sent.
The following topics are covered in this article:
- How to install Outgoing Webhook from the Zoom App Marketplace
- How to use the Outgoing Webhook app
- Configure the Outgoing Webhook app
- Send customized messages to Zoom Chat
- Available commands
- How to uninstall the Outgoing Webhook chat app
Prerequisites for using Outgoing 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 Outgoing Webhook Chat app
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
- You will need to sign in with your Zoom account in order to access the Zoom App Marketplace.
- To find Outgoing Webhook in your Google Play Store, simply enter “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 it in your search results.
- Add the item to your cart by clicking the Add button.
- Please confirm that the app needs the permissions you requested, then click the Authorize button.
A Zoom Chat notification will be sent to you directly from the chat application once the process has been completed.
Note: You will automatically be able to use the Outgoing Webhook chat application on your Zoom desktop client if your admin has installed it.
How to use the Outgoing Webhook app
Configure the Outgoing Webhook app
- Using the Zoom desktop application, sign in to your account.
- The Chat tab can be found by clicking on it.
- There is an Outgoing Webhook chatbot listed under BOTS on the left-hand panel.
Additionally, you can choose the chat channel that you would like to use.
- Click on the connect button and send the message. You will need to type /trigger connect if you do not see the Outgoing message in the chat channel but have navigated to another one.
A connection success message will be provided by the chat app in response to your request, along with a link for you to configure the webhook.
- Please click on the following link to get more information.
As soon as the page opens, you will be given the option to modify a variety of settings, including:
- This channel has the following name:
- If you have already initiated the “connect” command on this channel, you will be able to see it on this channel as well.
- The trigger word(s) are as follows:
- Please enter which commands will be sent to your endpoints so that they can receive the information from you. Taking the following example as an example:
- There is a trigger that triggers the process of creating a ticket. You will receive this trigger as the “trigger_word” in the payload of the email.
- To receive trigger word commands for your endpoints (one per line), enter the endpoints (one per line) in the text box.
- The token will be sent to your endpoint by Zoom in the payload which will contain information about your endpoint. In order to make sure that the request is coming from your Zoom chat, you can use this to verify it.
- In the event of a callback, the following URL will be used:
- The Zoom chat channel will be notified when triggers are sent back and will be used to respond to those triggers. The Token and this document will have to be used together in order for it to work
- Save the changes by clicking on the Save button.
Send customized messages to Zoom Chat
Upon triggering your system, your system can respond by sending your user a formatted message through Zoom chat in response to the trigger. There are a number of message types available within the chat app, including messages, actions, fields, selects, attachments, and sections.
Aside from selecting the type of message you want to send, you can further customize your message by specifying the style and functionality you want to use. Please refer to our article on Customizing Messages in the Marketplace for more information.
List all available commands
To receive a list of all available commands, type help in your Zoom Chat channel of choice or /trigger help in the 1:1 Outgoing Webhook chat channel.
Connect can be generated by typing the command connect in the 1:1 Outgoing Webhook chat channel or using the command /trigger connect in the Zoom Chat channel that you want to initiate the connection from. The configuration can be created by clicking the link provided.
In the 1:1 Outgoing Webhook chat channel, type configure [all] or /trigger configure [all] in any Zoom Chat channel that you desire to receive a list of your configurations with an edit link for each one to allow you to modify the settings.
There are two ways you can trigger your incoming message, using do + [your configured trigger words] + [Shift+Enter] + [Your desired text] in the 1:1 Outgoing Webhook chat channel or by adding /trigger do + [your configured trigger words] + [Shift+Enter] + [Your desired text] in your preferred Zoom Chat channel to trigger your incoming message and have the payload sent to you configured URLs. You will be able to send data through the chat app.
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 to enter /trigger disconnect if you want to remove the subscription from Zoom Chat. To confirm, click the OK button at the bottom of the screen.
Disconnect all subscriptions
To remove the subscription for the current chat channel, type /trigger disconnect all in your desired Zoom Chat channel to remove the subscription for the current incoming webhook chat channel, or type disconnect all in the 1:1 Outgoing Webhook chat channel. Confirm your decision by clicking the OK button.
How to uninstall the Outgoing Webhook chat app
- If you would like to access the Zoom Marketplace, you should sign in to your Zoom account.
- If you are 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 on the Remove button once you have confirmed the dialogue box.