Webex Teams Notifications

Overview

• Source: https://teams.webex.com
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 1000

Account Setup

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

Next you’ll need to install the ‘Incoming webhook’ plugin found under the ‘other’ category here: https://apphub.webex.com/integrations/

These links may not always work as time goes by and websites always change, but at the time of creating this plugin this was a direct link to it.

If you’re logged in, you’ll be able to click on the ‘Connect’ button. From there you’ll need to accept the permissions it will ask of you. 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 all you need to be interested in. Think of this URL as:

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

So as you can see, we have is 3 separate tokens. These are what you need to build your apprise URL with. In the above (simplified) example, the tokens are:

• Token: Y3lzY29zcGkyazovL3VzL1dFQkhPT0sajkkzYWU4fTMtMGE4Yy00

Note: Apprise supports this URL as-is (as of v0.7.7); you no longer need to parse the URL any further. However there is slightly less overhead (internally) if you do.

Syntax

Valid syntax is as follows:

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

Parameter Breakdown

Variable	Required	Description
token	Yes	The tokens provided to you after creating a incoming-webhook

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:

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