github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_discord (markdown)

master
Chris Caron 2023-06-17 16:18:34 -04:00
parent 19e66c4ff2
commit 6f09a0be5f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Notify_discord.md

@ -22,10 +22,10 @@ The last part of the URL you're given make up the 2 tokens you need to send noti
2. **WebhookToken** is ```JHMHI8qBe7bk2ZwO5U711o3dV_js``` 2. **WebhookToken** is ```JHMHI8qBe7bk2ZwO5U711o3dV_js```
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntax is as follows:
* `https://discordapp.com/api/webhooks/{WebhookID}/{WebhookToken}` * `https://discordapp.com/api/webhooks/{WebhookID}/{WebhookToken}`
* `discord://{WebhookID}/{WebhookToken}/` * `discord://{WebhookID}/{WebhookToken}/`
* `discord://{user}@{WebhookID}/{WebhookToken}/` * `discord://{botname}@{WebhookID}/{WebhookToken}/`
Discord can also support a variety of website arguments, the below identifies the defaults and therefore do not need to be specified unless you want to override them: Discord can also support a variety of website arguments, the below identifies the defaults and therefore do not need to be specified unless you want to override them:
* `discord://{WebhookID}/{WebhookToken}/?tts=No&avatar=Yes&footer=No&image=Yes` * `discord://{WebhookID}/{WebhookToken}/?tts=No&avatar=Yes&footer=No&image=Yes`
@ -35,7 +35,7 @@ Discord can also support a variety of website arguments, the below identifies th
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| WebhookID | Yes | The first part of 2 tokens provided to you after creating a *incoming-webhook* | 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* | WebhookToken| Yes | The second part of 2 tokens provided to you after creating a *incoming-webhook*
| user | 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*). | botname | 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**) | 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**) | footer | No | Include a message footer (by default is is set to **No**)
| image | No | Include an image in-line with the message describing the notification type (by default is is set to **Yes**) | image | No | Include an image in-line with the message describing the notification type (by default is is set to **Yes**)
@ -49,7 +49,7 @@ Send a discord notification:
# Assuming our {WebhookID} is 4174216298 # Assuming our {WebhookID} is 4174216298
# Assuming our {WebhookToken} is JHMHI8qBe7bk2ZwO5U711o3dV_js # Assuming our {WebhookToken} is JHMHI8qBe7bk2ZwO5U711o3dV_js
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js "discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js"
``` ```
If you want to have your own custom avatar URL you're already hosting from another website, you could set the following: If you want to have your own custom avatar URL you're already hosting from another website, you could set the following:
@ -58,5 +58,5 @@ If you want to have your own custom avatar URL you're already hosting from anoth
# Assuming our {WebhookToken} is JHMHI8qBe7bk2ZwO5U711o3dV_js # Assuming our {WebhookToken} is JHMHI8qBe7bk2ZwO5U711o3dV_js
# Assuming our {AvatarURL} is https://i.imgur.com/FsEpmwg.jpeg # Assuming our {AvatarURL} is https://i.imgur.com/FsEpmwg.jpeg
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js?avatar_url=https://i.imgur.com/FsEpmwg.jpeg "discord://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js?avatar_url=https://i.imgur.com/FsEpmwg.jpeg"
``` ```