Skip to content

Zoom Team Chat Notifications

Overview

Zoom Team Chat notifications are delivered through the Incoming Webhook app available on the Zoom Marketplace. The app posts messages into a channel of your choice.

  1. Sign in to https://marketplace.zoom.us and search for Incoming Webhook.

  2. Click Add to install the app to your Zoom account.

  3. Open Zoom Team Chat and navigate to the channel you want to receive notifications.

  4. In the message input box, type the slash command:

    /inc connect

    Follow the on-screen prompts. When complete, Zoom provides two values:

    • Endpoint URL — for example:

      https://inbots.zoom.us/incoming/hook/AbCdEfGhIjKl
    • Verification Token — a short alphanumeric string used to authenticate requests.

  5. The Webhook ID is the final path segment of the endpoint URL (AbCdEfGhIjKl in the example above).

Assemble your Apprise URL using both values:

zoom://{webhook_id}/{token}

Valid syntax is as follows:

  • zoom://{webhook_id}/{token}/
  • zoom://{webhook_id}/{token}/?mode=full
  • zoom://{webhook_id}/{token}/?mode=simple
  • https://inbots.zoom.us/incoming/hook/{webhook_id}?token={token}

Full mode (default) sends a structured message. When a notification title is provided it appears as a heading above the message body. This uses Zoom’s ?format=full API parameter.

Simple mode sends the message as a plain-text string. If a title is provided it is prepended to the body separated by a colon.

VariableRequiredDescription
webhook_id*YesThe Webhook ID from the Zoom endpoint URL (the path segment after /hook/).
token*YesThe Verification Token provided by Zoom when the webhook was created.
modeNoNotification mode: full (default, structured with heading) or simple (plain text).
VariableDescription
overflowThis parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream
👉 upstream: Do nothing at all; pass the message exactly as you received it to the service.
👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated.
👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
formatThis parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verifyExternal requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
redirectBy default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes.
ctoThis stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rtoThis stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojisEnable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no.
Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tzIdentify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.
retryThe number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
waitThe number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value.
optionalWhen set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still returns True even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Send a notification using the default full mode:

Terminal window
# Replace AbCdEfGhIjKl with your Webhook ID
# Replace VerToken123 with your Verification Token
apprise -vv -t "Alert Title" -b "Something happened." \
zoom://AbCdEfGhIjKl/VerToken123/

Send a plain-text notification using simple mode:

Terminal window
apprise -vv -t "Info" -b "Deployment complete." \
"zoom://AbCdEfGhIjKl/VerToken123/?mode=simple"

Use the native endpoint URL with the token appended as a query parameter:

Terminal window
apprise -vv -b "Webhook test." \
"https://inbots.zoom.us/incoming/hook/AbCdEfGhIjKl?token=VerToken123"
Questions or Feedback?

Documentation

Notice a typo or an error? Report it or contribute a fix .

Technical Issues

Having trouble with the code? Open an issue on GitHub:

Made with love from Canada