Incoming Webhook Chatbot

Overview

Prerequisites

  • Free or Paid Zoom Account
  • Familiarity with sending HTTP POST requests with a token and endpoint
  • Pre-approval of the Incoming Webhook chatbot in the Zoom Marketplace
    Note: If the app is not pre-approved, please contact your Zoom admin.

Installation and Configuration

Installing from the Zoom Marketplace

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

  1. Login to your Zoom account and navigate to the Zoom Marketplace.
  2. Search for Incoming Webhook and click the app.
  3. If the app is not pre-approved, contact your Zoom admin to approve this app for your account.
  4. Click Install, confirm the permissions the app requires and choose Authorize.
  5. The Incoming Webhook Chatbot is now installed.

Configuring the Incoming Webhook Chatbot

  1. Login to the Zoom Client and navigate to the chat tab.
  2. Search for Incoming Webhook under apps or navigate to a chat channel that you would like to receive messages in.
  3. 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.

      newConnectionResponse
  4. You will be able to utilize this information to send your POST requests. Note: You will need to complete these steps for every channel you would like to have the Incoming Webhook chatbot send messages to.

Sending Messages to Zoom Chat

After you have created your connection, you can then start sending POST requests to the integration’s endpoint. Make sure 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 utilize terminal or an open git-bash(or equivalent that supports curl commands). You can copy the example curl from the inital 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:

    simpleResponse

    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 as such:

    fieldsResponse

    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:

    listResponse

    To se this formatting ad 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:

    fullResponse

    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.

Using 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.

Uninstalling the Incoming Webhook Chatbot

  1. (Optional) To remove connections from your Zoom Chat Channels, navigate to your Zoom Chat and type /im disconnect all.
  2. Navigate to the Zoom Marketplace.
  3. Search for Confluence and click the app or navigate to your installed apps via Manage > Installed Apps.
  4. Click Uninstall next to Confluence.
  5. Confirm the dialogue and click Uninstall.
    Note: Performing this step will also remove all active connections within Zoom Chat.

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