From 91882925a2487082762c017c7d4db6030fa3dc64 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sun, 7 Apr 2019 11:18:06 -0400 Subject: [PATCH] Created Notify_wxteams (markdown) --- Notify_wxteams.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 Notify_wxteams.md diff --git a/Notify_wxteams.md b/Notify_wxteams.md new file mode 100644 index 0000000..d2747a6 --- /dev/null +++ b/Notify_wxteams.md @@ -0,0 +1,42 @@ +## Webex Teams Notifications +* **Source**: https://teams.webex.com +* **Icon Support**: No +* **Message Format**: Markdown +* **Message Limit**: 1000 Characters per message + +### 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](https://apphub.webex.com/integrations/incoming-webhooks-cisco-systems). + +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` + +### Syntax +Valid syntax is as follows: +* **wxteams**://**{token}**/ + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| token | Yes | The tokens provided to you after creating a *incoming-webhook* + +#### Example +Send a Webex Teams notification: +```bash +# Assuming our {token} is T1JJ3T3L2DEFK543 +apprise wxteams:///T1JJ3T3L2DEFK543/ +```