Using Zoom's Incoming Webhook Chatbot

Last Updated:

The Incoming Webhook app allows you to send messages from your external services, such as Amazon CloudWatch, directly to any Zoom chat channel. Use the chat app in any channel to generate a unique endpoint and verification token. With these credentials, you can send messages to your Zoom chat channel through HTTP POST requests. 

This article covers:

Prerequisites for Incoming Webhook

  • Account owner or admin privileges
  • Pro, Business, Education, or Enterprise account
  • Familiarity with sending HTTP POST requests with a token and endpoint
  • Pre-approval of the Incoming Webhook chatbot in the Zoom App Marketplace
    Note: If the app is not pre-approved, please contact your Zoom admin.

How to add and configure Incoming Webhook

Add from the Zoom App Marketplace

Note: You will need to have administrative privileges on your Zoom account to add and configure the Incoming Webhook Chatbot

  1. Sign in to the Zoom App Marketplace as the account administrator.
  2. In the top right of your screen, enter Incoming Webhook in the search box to find the app.
  3. In your search results, find the Incoming Webhook app and click it.
    Note: If the app is not pre-approved, contact your Zoom admin to approve this app for your account. 
  4. Click Add.
  5. Confirm the permissions the app requires, then click Authorize.
    The Incoming Webhook app is now added.

Configure the Incoming Webhook Chatbot

  1. Sign in to the Zoom desktop client.
  2. Click the Chat tab.
  3. Under BOTS, search for Incoming Webhook.
     You can also go to a chat channel that you would like to receive messages in.
  4. Type /inc connect <connectionName>.
    This will create a connection and send you a 1:1 chat message with details including:
    • Endpoint
    • Verification token
    • Example cURL requests.
  5. You can use this information to send your POST requests.
    Note: You must complete these steps for every channel you want to have the Incoming Webhook chatbot send messages to.

How to send messages to Zoom chat

After you have created your connection, you can then start sending POST requests to the integration’s endpoint. Ensure that you have configured to add the verification token to the Authorization header.
Note: The endpoint only accepts POST requests.

To test your connection, you can use terminal or an open git-bash (or an equivalent that supports cURL commands). You can copy the example cURL from the initial 1:1 chat message from the Incoming Webhook Chatbot and send the cURL request. Once sent, you should see the test message sent in the specified channel. A successful test will respond with 200 OK.

When sending messages using the Incoming Webhook Chatbot, you will have 4 options for the type and complexity of your messages:

  • Simple format: This format allows you to send plain text coming from the created connection. To use this formatting, simply use the endpoint without any query parameters. You will need to send your content as a string in the body.
POST <endpoint>
Authorization: <verificationToken>
Body: "This is a test message."
  • Fields format: This format allows you to send simple formatting in fields. For example, you can have your message formatted into fields. To use this formatting, add fields as the format (?format=fields) in the query parameter.
POST <endpoint>?format=fields
Authorization: <verificationToken>
Content-Type: application/json
Body:
{
    "Field 1": "bar",
    "Field 2": "qux"
}
  • List format: This format allows you to send simple formatting as a list. For example, you can have your message formatted as a list. To use this formatting, add list as the format (?format=list) in the query parameter.
POST <endpoint>?format=list
Authorization: <verificationToken>
Content-Type: application/json
Body:
{
    "Item 1": "Item 1",
    "Item 2": "Item 2"
}
  • Full format: This format will allow to generate and send rich message formatting in Zoom Chat messages. Such formatting allows you to use headers, subheaders, links, buttons, dropdowns, attachments, and more to your chatbot messages. To use this formatting, you will need to append full as the format (?format=full) in the query parameter. For more information on the supported JSON objects, please see this reference.

How to use the Incoming Webhook Chatbot

Available commands

  • Connect: Type /inc connect <connectionName> to create an endpoint(URL) and token to start sending messages directly to your current chat channel. This Chatbot supports 1:1 direct messages as well as channels.
  • Regenerate token: Type /inc regenerate <connectionName> to regenerate the verification token for the specified connection.
  • Disconnect: Type /inc disconnect <connectionName> to remove the specified connection.
  • Disconnect all: Type /inc disconnect all to remove all connections for the Incoming Webhook Chatbot.
  • Configure: Type /inc configure to list the connections for the current chat channel.
  • Configure All: Type /inc configure all to list the connections for all channels.

How to remove the Incoming Webhook Chatbot

  1. Sign in to the Zoom App Marketplace as the account administrator.
  2. In the top-right corner the page, click Manage.
  3. In the navigation menu, click Added Apps.
  4. Next to the Incoming WebHook app, click Remove.
  5. Confirm the dialogue and click Remove.
    Note: Performing this step will also remove all active connections in Zoom Chat.

For additional help or technical support, please submit a ticket.

Zoom Community

Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.