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. | STRING | |
tts | Whether to send the message as text-to-speech. | BOOLEAN | false |
embeds | A list of embed objects to include in the webhook message. | ANY | |
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:
key: <value> # ← Optional
Behaviour
| Setting | Value |
|---|
| Run order | NORMAL |
| Supports delay | true |
| Reloads on plugin reload | true |
| Permanent | false |