diff --git a/Notify_guilded.md b/Notify_guilded.md new file mode 100644 index 0000000..3e20f8b --- /dev/null +++ b/Notify_guilded.md @@ -0,0 +1,61 @@ +## Guilded Notifications +* **Source**: https://guilded.gg/ +* **Icon Support**: Yes +* **Attachment Support**: Yes +* **Message Format**: Text +* **Message Limit**: 2000 Characters per message + +### Account Setup +First set up a Guilded account on the website. From there you will need to generate a webhook. + +The webhook will end up looking something like this: +```https:/media.guilded.gg/webhooks/4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js``` + +This effectively equates to: +```https://media.guilded.gg/webhooks/{WebhookID}/{WebhookToken}``` + +**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. + +The last part of the URL you're given make up the 2 tokens you need to send notifications with. With respect to the above example the tokens are as follows: +1. **WebhookID** is ```4174216298``` +2. **WebhookToken** is ```JHMHI8qBe7bk2ZwO5U711o3dV_js``` + +### Syntax +Valid syntaxes are as follows: +* `https://media.guilded.gg/webhooks/{WebhookID}/{WebhookToken}` +* `guilded://{WebhookID}/{WebhookToken}/` +* `guilded://{user}@{WebhookID}/{WebhookToken}/` + +Guilded 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: +* `guilded://{WebhookID}/{WebhookToken}/?tts=No&avatar=Yes&footer=No&image=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* +| 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*). +| 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**) +| image | 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 guilded avatar icon and replace it with one identify the notification type (by default is is set to **Yes**) +| avatar_url | No | Over-ride the default guilded avatar icon URL. By default this is not set and Apprise chooses the URL dynamically based on the type of message (info, success, warning, or error). +| format | No | The default value of this is _text_. But if you plan on managing the format yourself, you can optionally set this to _markdown_. If the mode is set to markdown, apprise will scan for header entries (usually on lines by themselves surrounded by hashtags (#)) and will place these inside embedded objects. This is done to give a nicer presentation. + +#### Example +Send a guilded notification: +```bash +# Assuming our {WebhookID} is 4174216298 +# Assuming our {WebhookToken} is JHMHI8qBe7bk2ZwO5U711o3dV_js +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + guilded://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: +```bash +# Assuming our {WebhookID} is 4174216298 +# Assuming our {WebhookToken} is JHMHI8qBe7bk2ZwO5U711o3dV_js +# Assuming our {AvatarURL} is https://i.imgur.com/FsEpmwg.jpeg +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + guilded://4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js?avatar_url=https://i.imgur.com/FsEpmwg.jpeg +```