Created Notify_msteams (markdown)

Chris Caron 2019-04-05 22:30:31 -04:00
parent a5b23e31f2
commit e18c24f1a2

55
Notify_msteams.md Normal file

@ -0,0 +1,55 @@
## Microsoft Teams Notifications
* **Source**: https://teams.microsoft.com
* **Icon Support**: Yes
* **Message Format**: Markdown
* **Message Limit**: 1000 Characters per message
### Account Setup
Create a free account at https://teams.microsoft.com.
You will need to create an **Incoming Webhook** to attach Apprise. This can be accomplished through the **the app store** (bottom left hand side of slack like interface); don't worry it's free. From within the app store, search for **Incoming Webhook**. Once you click on it you can associate it with your team. You can also assign it a name, and an avatar. Finally you will have to assign it to a channel.
When you've completed this, it will generate you a URL that looks like:
```
https://outlook.office.com/webhook/ \
abcdefgf8-2f4b-4eca-8f61-225c83db1967@abcdefg2-5a99-4849-8efc-\
c9e78d28e57d/IncomingWebhook/291289f63a8abd3593e834af4d79f9fe/\
a2329f43-0ffb-46ab-948b-c9abdad9d643
```
Yes... The URL is that big... but at the end of the day, it looks like this (greatly simplified)
This effectively equates to:
```https://outlook.office.com/webhook/{tokenA}/IncomingWebhook/{tokenB}/{tokenC}```
Hence:
```
https://outlook.office.com/webhook/ABCD@WXYZ/IncomingWebhook/DEFG/HIJK
^ ^ ^
| | |
These are important <----------------^----------------------^----^
```
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 example the tokens are as follows:
1. **TokenA** is ```ABCD@WXYZ```
2. **TokenB** is ```DEFG```
3. **TokenC** is ```HIJK```
### Syntax
Valid syntax is as follows:
* **msteams**://**{tokenA}**/**{tokenB}**/**{tokenC}**/
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| tokenA | Yes | The first part of 3 tokens provided to you after creating a *incoming-webhook*
| tokenB | Yes | The second part of 3 tokens provided to you after creating a *incoming-webhook*
| tokenC | Yes | The last part of 3 tokens provided to you after creating a *incoming-webhook*
#### Example
Send a Microsoft Teams notification:
```bash
# Assuming our {tokenA} is T1JJ3T3L2@DEFK543
# Assuming our {tokenB} is A1BRTD4JD
# Assuming our {tokenC} is TIiajkdnlazkcOXrIdevi7F
apprise msteams:///T1JJ3T3L2@DEFK543/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/
```