How to Use Zoom’s Incoming Webhook Chatbot

Incoming Webhooks is an app that allows you to send messages directly to any Zoom chat channel that you have in your account from your external services, such as Amazon CloudWatch. It is possible to create a unique endpoint and verification token in any channel by using the chat app in that channel. Using these credentials, you will be able to send messages through HTTP POST requests to your Zoom chat channel within seconds.

The following topics are covered in this article:

  • How to add and configure Incoming Webhook
    • Add from the Zoom App Marketplace
    • Configure the Incoming Webhook Chatbot
  • How to send messages to Zoom Chat
  • How to use the Incoming Webhook Chatbot
    • Available commands
  • How to remove the Incoming Webhook Chatbot

Prerequisites for Incoming Webhook

  • Ownership or administrative privileges of the account
  • An account that is either a Professional, Business, Education, or Enterprise account
  • A working knowledge of sending HTTP POST requests with an endpoint and a token.
  • The Zoom App Marketplace has approved the Incoming Webhook chatbot for inclusion in its store
    Note: Please contact your Zoom administrator if the app is not pre-approved by Zoom before you submit it.

How to add and configure Incoming Webhook

Add from the Zoom App Marketplace

Note: The Incoming Webhook Chatbot will require you to have administrative privileges within your Zoom account in order to be added and configured.

  1. Ensure that you are logged in as the account administrator in the Zoom App Marketplace.
  2. To find Incoming Webhook, simply enter the name of the app in the search box in the top right corner of your screen.
  3. Find the Incoming Webhook app in the search results, and then click it in order to access the app.
    Note: Please contact your Zoom admin if you have not been pre-approved for this app, so that it may be added to your account.
  4. Add the item to your cart by clicking the Add button.
  5. When the app asks for permissions, confirm them and click the Authorize button to give them.
    There is now an Incoming Webhook app available for download.
See also  Can I join a conference via dial-in in Zoom conference? (Premium voice option)

Configure the Incoming Webhook Chatbot

  1. Open the Zoom desktop client on your computer and sign in.
  2. Please click on the Chat tab at the top of the page.
  3. The Incoming Webhook can be found under the BOTS section.
    If you want to receive messages in a specific chat channel, you will need to go to that specific channel.
  4. You can connect to a connection by typing /inc connect <connectionName>.
    After clicking on this, a 1:1 chat message will be sent to you with details about your connection, including:

    • Endpoint
    • Verification token
    • Example cURL requests.
  5. If you would like to send a POST request using this information, then you can use this information.
    Note: There are several steps you need to follow in order to have the Incoming Webhook chatbot send messages to every channel you wish to use it on.

How to send messages to Zoom chat

The first step in the process of connecting to the integration is to create the connection and then send POST requests to the integration’s endpoint. The verification token should be added to the Authorization header of the request if you have configured that option.
Note: There are only POST requests that can be made to the endpoint.

It is recommended to use an open git-bash (or an equivalent that supports cURL commands) for testing your connection, but terminal is also an option. From the initial 1:1 chat message that is sent by the Incoming Webhook Chatbot, you can copy the example cURL from the chatbot’s incoming message and send the similar cURL request. Upon sending the test message, you should be able to see it in the specified channel once it has been sent. As a result of a successful test, a 200 OK response will be returned.

It is possible for you to select a number of different types and complexity levels for your messages when you use the Incoming Webhook Chatbot:

  • Simple format: This format can be used to send plain text that originates from the connection that was created. For this format to be used, all you have to do is use the endpoint without any query parameters attached. The content of your message will need to be sent as a string in the body of the message.
POST <endpoint>
Authorization: <verificationToken>
Body: "This is a test message."
  • Fields format: In this format, you are able to include simple formatting within fields. If you want, you can format your message in the form of fields, for example. Add fields to the query parameter so that the formatting can be used (?format=fields) to retrieve the data in this format.
POST <endpoint>?format=fields
Authorization: <verificationToken>
Content-Type: application/json
    "Field 1": "bar",
    "Field 2": "qux"
  • List format: In this format, simple formatting can be sent as a list in a message. Your message can be formatted in a list format, for example, if you wish. As a query parameter, you will have to add list as the format (?format=list) in order to use this formatting.
POST <endpoint>?format=list
Authorization: <verificationToken>
Content-Type: application/json
    "Item 1": "Item 1",
    "Item 2": "Item 2"
  • Full format: With the help of this format, Zoom Chat messages can be formatted in a rich way and sent as rich messages. As a result of this format, you will be able to include headers, subheaders, links, buttons, dropdown menus, attachments, and more in your chatbot messages. In order to use this format, you will need to append the format full to your query parameters (?format=full) before you start the query. Please take a look at this reference for more information about the types of JSON objects that are supported.
See also  Zoom App installation method (PC version)

How to use the Incoming Webhook Chatbot

Available commands

  • Connect: In order to start sending messages to your current chat channel, you must first create an endpoint (URL) and token by typing /inc connect *connectionName>. As well as 1:1 direct messages, this chatbot supports channels as well.
  • Regenerate token: If the connection name you have specified is the name that you would like to regenerate, then type /inc regenerate *connectionName>.
  • Disconnect: In order to disconnect the connection specified by the connection name, please type /inc disconnect *connectionName>.
  • Disconnect all: The Incoming Webhook Chatbot can be disconnected by typing the command /inc disconnect all in order to remove all connections.
  • Configure: For a list of the connections associated with the current chat channel, type /inc configure.
  • Configure All: The connections for all channels can be viewed by typing /inc configure all.

How to remove the Incoming Webhook Chatbot

  1. Please sign in as the account administrator of your Zoom account in order to access the Zoom App Marketplace.
  2. On the left-hand side of the page, you will notice a Manage button in the upper-right corner.
  3. Click the Added Apps link in the navigation menu on the left side of the page.
  4. Click on the Remove button next to the Incoming WebHook app so that it can be removed.
  5. Please confirm the dialogue box by clicking the Remove button.
    Note: You should perform this step as soon as possible in order to remove all active Zoom Chat connections as well.