Skip to content

Discord

URL Format

Your Discord Webhook-URL will look like this:

https://discordapp.com/api/webhooks/webhookid/token

The shoutrrr service URL should look like this:

discord://token@webhookid

URL Fields

  • Token (Required)
    URL part: discord://token@webhookid/
  • WebhookID (Required)
    URL part: discord://token@webhookid/

Query/Param Props

Props can be either supplied using the params argument, or through the URL using
?key=value&key=value etc.

  • AvatarURL - Override the webhook default avatar
    Default: empty

  • Color - The color of the left border for plain messages
    Default: 0x50D9ff

  • ColorDebug - The color of the left border for debug messages
    Default: 0x7b00ab

  • ColorError - The color of the left border for error messages
    Default: 0xd60510

  • ColorInfo - The color of the left border for info messages
    Default: 0x2488ff

  • ColorWarn - The color of the left border for warning messages
    Default: 0xffc441

  • JSON - Whether to send the whole message as the JSON payload instead of using it as the 'content' field
    Default: ❌ No

  • SplitLines - Whether to send each line as a separate embedded item
    Default: ✔ Yes

  • Title
    Default: empty

  • Username - Override the webhook default username
    Default: empty

Creating a webhook in Discord

  1. Open your server settings by first clicking on the name of the server. Screenshot 1

  2. Then click on Server Settings. Screenshot 2

  3. In the menu on the left, click on Webhooks. Screenshot 3

  4. In the top right corner, click on Create Webhook. Screenshot 4

  5. Set name, channel and icon to your liking and copy the Webhook URL on the bottom. Then click save. Screenshot 5

  6. Format the service URL

    https://discordapp.com/api/webhooks/693853386302554172/W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ
                                        └────────────────┘ └──────────────────────────────────────────────────────────────────┘
                                            webhook id                                    token
    
    discord://W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ@693853386302554172
              └──────────────────────────────────────────────────────────────────┘ └────────────────┘
                                              token                                    webhook id