Webex Teams Notifications

Overview

• Source: https://teams.webex.com
• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Webhook: 1000
  • Bot API: 7439
• Build Your Apprise URL

Account Setup

Webex Teams notifications can be sent in two modes: Webhook (simple, no attachments) and Bot (full API access with file attachment support). The mode is auto-detected from the token format, or you can force it with the mode= URL parameter.

Mode 1 — Webhook (default)

To use webhook mode, first access https://teams.webex.com and create an account if you don’t already have one. You’ll want to create at least one ‘space’ before getting the ‘incoming webhook’.

Next, install the ‘Incoming webhook’ integration found under the ‘other’ category at https://apphub.webex.com/integrations/. At the time of writing, this was a direct link to it.

If you’re logged in, click on the ‘Connect’ button, accept the permissions, and give the webhook a name such as ‘apprise’.

When you’re complete, you will receive a URL that looks something like this:

https://api.ciscospark.com/v1/webhooks/incoming/\
       Y3lzY29zcGkyazovL3VzL1dFQkhPT0sajkkzYWU4fTMtMGE4Yy00

The last part of the URL is your {token}:

• https://api.ciscospark.com/v1/webhooks/incoming/{token}

Note: Apprise supports this URL as-is (as of v0.7.7).

Limitation: Incoming webhooks do not support file attachments. Use Bot mode (below) if you need to send files.

Mode 2 — Bot (API token + Room ID, supports attachments)

1. Visit https://developer.webex.com/my-apps and create a new Bot.
2. After creating the bot, copy the Bot Access Token shown on the confirmation page (it is only shown once).
3. Invite the bot to the space/room you want it to post to.
4. Retrieve the Room ID for that space. You can list rooms via the Rooms API. The Room ID is a long base64url string such as Y2lzY29zcGFyazovL3VzL1JPTU9NLzEyMzQ1.

Assemble your Apprise URL as:

wxteams://{bot_token}/{room_id}

Syntax

Valid syntax is as follows:

Webhook Mode

• https://api.ciscospark.com/v1/webhooks/incoming/{token}
• https://webexapis.com/v1/webhooks/incoming/{token}
• wxteams://{token}/
• webex://{token}/

Bot Mode

• wxteams://{bot_token}/{room_id}/
• wxteams://{bot_token}/{room_id1}/{room_id2}/

You can force a mode explicitly by appending ?mode=webhook or ?mode=bot. If omitted, the mode is auto-detected from the token format:

• A token of 80–160 alphanumeric characters is treated as a webhook token.
• Any other token (longer, or containing non-alphanumeric characters) is treated as a bot access token and requires at least one Room ID.

Parameter Breakdown

Variable	Required	Description
token	Yes	Webhook token or Bot access token (auto-detected by format)
room_id	Bot only	Room ID of the Webex space to post to (may repeat for multiple)
mode	No	Force webhook or bot mode (auto-detected if omitted)

Global Parameters

Variable	Description
overflow	This 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.
format	This 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.
verify	External 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.
cto	This 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.
rto	This 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.
emojis	Enable 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.
tz	Identify 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.

Examples

Send a Webex Teams notification via webhook:

# Assuming our {token} is T1JJ3T3L2DEFK543
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   wxteams://T1JJ3T3L2DEFK543/

Send a notification via Bot API to a specific room:

# bot_token and room_id are placeholders for your actual values
apprise -vv -b "Hello from Apprise Bot" \
   wxteams://NThhZjI0NzQtMGQx.../Y2lzY29zcGFyazovL3Vz.../

Send a notification with a file attachment (Bot mode required):

apprise -vv -b "See attached report" \
   --attach /path/to/report.pdf \
   wxteams://NThhZjI0NzQtMGQx.../Y2lzY29zcGFyazovL3Vz.../

Post to multiple rooms from one Bot token:

apprise -vv -b "Broadcast message" \
   wxteams://{bot_token}/{room_id1}/{room_id2}/