send_discord_webhook
Sends a message to a Discord channel via a webhook URL.
Categories: chat
Required arguments
| Key(s) | Description | Type |
|---|---|---|
webhook_url | The Discord webhook URL to send the message to. | STRING |
text | The message content to send to the webhook. | STRING |
Optional arguments
| Key(s) | Description | Type | Default |
|---|---|---|---|
username | The display name to use for the webhook message. | STRING | |
avatar_url | A URL to an image to use as the webhook avatar. Taken literally: unlike username and text, this is not formatted, so placeholders in it are not replaced. | STRING | |
tts | Whether to send the message as text-to-speech. | BOOLEAN | false |
embeds | A list of embed subsections to include in the webhook message, each with title, description, url, color, timestamp, author, footer, image, thumbnail, and fields. | DYNAMIC |
embeds entries
| Key | Description | Type | Required |
|---|---|---|---|
title | The embed title, shown in bold at the top of the embed. Supports placeholders. | STRING | no |
description | The embed body text. Supports placeholders. | STRING | no |
url | A URL to make the title a clickable link to. Does not support placeholders. | STRING | no |
color | The embed sidebar color as a hex string, with or without a leading hash. | STRING | no |
timestamp | An ISO-8601 timestamp to show in the embed footer, e.g. 2026-01-01T12:00:00Z. | STRING | no |
author | The author line shown above the title. | OBJECT | no |
author.name | The author name shown above the embed title. Supports placeholders. | STRING | no |
author.url | A URL to make the author name a clickable link to. Does not support placeholders. | STRING | no |
author.icon-url | A URL to an image to show as the author icon. Does not support placeholders. | STRING | no |
footer | The footer line shown below the embed body. | OBJECT | no |
footer.text | The footer text shown below the embed body. Supports placeholders. | STRING | no |
footer.icon-url | A URL to an image to show as the footer icon. Does not support placeholders. | STRING | no |
image | The large image shown at the bottom of the embed. | OBJECT | no |
image.url | A URL to the image to show. Does not support placeholders. | STRING | yes |
thumbnail | The small image shown in the top right of the embed. | OBJECT | no |
thumbnail.url | A URL to the image to show. Does not support placeholders. | STRING | yes |
fields | A list of name-value fields shown in the embed body. | OBJECT_LIST | no |
fields[].name | The field name, shown in bold. Supports placeholders. | STRING | no |
fields[].value | The field value, shown below the name. Supports placeholders. | STRING | no |
fields[].inline | Whether to show this field on the same line as adjacent inline fields. | BOOLEAN | no |
Example
effects:
- id: send_discord_webhook
args:
webhook_url: https://discord.com/api/webhooks/123456789012345678/abcDEF-token
text: %player_name% just found a legendary item!
username: <value> # ← Optional
avatar_url: https://example.com/avatar.png # ← Optional
tts: true # ← Optional
embeds: # ← Optional
- title: <value> # ← Optional
description: <value> # ← Optional
url: <value> # ← Optional
color: <value> # ← Optional
timestamp: <value> # ← Optional
author: # ← Optional
name: <value> # ← Optional
url: <value> # ← Optional
icon-url: <value> # ← Optional
footer: # ← Optional
text: <value> # ← Optional
icon-url: <value> # ← Optional
image: # ← Optional
url: <value>
thumbnail: # ← Optional
url: <value>
fields: # ← Optional
- name: <value> # ← Optional
value: <value> # ← Optional
inline: <value> # ← Optional
Behaviour
| Setting | Value |
|---|---|
| Run order | NORMAL |
| Supports delay | true |
| Reloads on plugin reload | true |
| Permanent | false |