extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-12 18:01:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Created Notify_discord (markdown)

lead2gold 2018-02-25 20:39:56 -05:00
parent 23b8dafdd4
commit f9234455ab
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Notify_discord.md Normal file

@ -0,0 +1,43 @@
## Discord Notifications
* **Source**: https://discordapp.com/
* **Icon Support**: Yes
* **Message Format**: Text
* **Message Limit**: 2000 Characters per message
### Account Setup
Creating a Discord account is easy. The only part that requires a little bit of extra work is once you've got a channel set up (by default discord puts you in a #General channel). Click on the Gear icon (Settings) and from here you need to enable webhooks.
The webhook will end up looking something like this:
```https://discordapp.com/api/webhooks/417429632418316298/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV_js```
This effectively equates to:
```https://discordapp.com/api/webhooks/{WebhookID}/{WebhookToken}```
The last part of the URL you're given make up the 2 tokens you need to send notifications with It's very important to pay attention. In the above example the tokens are as follows:
1. **WebhookID** is ```417429632418316298```
2. **WebhookToken** is ```JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV_js```
### Syntax
Valid syntaxes are as follows:
* **discord**://**{WebhookID}**/**{WebhookToken}**/
* **discord**://**{userid}**@**{WebhookID}**/**{WebhookToken}**/
* **discord**://**{WebhookID}**/**{WebhookToken}**/?tts=Yes
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| WebhookID | Yes | The first part of 2 tokens provided to you after creating a *incoming-webhook*
| WebhookToken| Yes | The second part of 2 tokens provided to you after creating a *incoming-webhook*
| userid | No | Identify the name of the bot that should issue the message. If one isn't specified then the default is to just use your account (associated with the *incoming-webhook*).
| tts | No | Enable Text-To-Speech (by default is is set to **No**)
| footer | No | Include a message footer (by default is is set to **No**)
| thumbnail | No | Include an image in-line with the message describing the notification type (by default is is set to **Yes**)
| avatar | No | Over-ride the default discord avatar icon and replace it with one identify the notification type (by default is is set to **Yes**)
#### Example
Send a discord notification:
```bash
# Assuming our {WebhookID} is 417429632418316298
# Assuming our {WebhookToken} is JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV_js
notify discord:///T1JJ3T3L2/A1BRTD4JD/JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV_js
```