GroupeZ Docs
Modules

Discord Module

Discord webhook notifications and account linking

File: modules/discord/config.yml

The Discord module integrates your Minecraft server with Discord through webhook notifications and account linking. It can send messages to Discord channels when players chat, join, leave, or join for the first time. It also supports a secure account linking system that associates Minecraft accounts with Discord accounts.

For the standalone Discord bot used for account linking, see the Discord Bot page.

Source Configuration

enable: true
chat-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  avatar: "https://mc-heads.net/avatar/%uuid%"
  message: "%message%"
  username: "%player%"
join-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  embeds:
    - author:
        name: "%player% just logged in"
        icon-url: "https://mc-heads.net/head/%uuid%"
      color: "#00ff00"
left-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  embeds:
    - author:
        name: "%player% just logged out"
        icon-url: "https://mc-heads.net/head/%uuid%"
      color: "#ff0000"
first-join-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  embeds:
    - author:
        name: "%player% just logged in for the first time"
        icon-url: "https://mc-heads.net/head/%uuid%"
      color: "#44ff44"
enable-link-account: false
log-link-error-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  message: "%player% vient d'essayer de lier son compte avec le code `%code%`"
log-link-success-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  message: "%player% vient de lier son compte avec le code `%code%` (%discord-name%:%discord-id%)"
log-unlink-message:
  enable: false
  webhook: "https://discord.com/api/webhooks/"
  message: "%player% vient de délier son compte (%discord-name%:%discord-id%)"

Options

General Options

OptionTypeDefaultDescription
enableBooleantrueEnable or disable the Discord module
enable-link-accountBooleanfalseEnable the Discord account linking feature. Requires the Discord Bot to be running

Chat Message Webhook

Forwards in-game chat messages to a Discord channel via webhook. The webhook message appears with the player's avatar and name.

OptionTypeDefaultDescription
chat-message.enableBooleanfalseEnable or disable chat message forwarding to Discord
chat-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL to send chat messages to
chat-message.avatarStringhttps://mc-heads.net/avatar/%uuid%URL template for the webhook avatar image. Use %uuid% for the player's UUID
chat-message.messageString%message%The message content sent to Discord. Use %message% for the chat message text
chat-message.usernameString%player%The username displayed on the webhook message. Use %player% for the player name

Join Message Webhook

Sends a Discord embed when a player joins the server.

OptionTypeDefaultDescription
join-message.enableBooleanfalseEnable or disable join message notifications
join-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL for join notifications
join-message.embedsList(see above)List of embed objects sent when a player joins

Left Message Webhook

Sends a Discord embed when a player disconnects from the server.

OptionTypeDefaultDescription
left-message.enableBooleanfalseEnable or disable leave message notifications
left-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL for leave notifications
left-message.embedsList(see above)List of embed objects sent when a player leaves

First Join Message Webhook

Sends a Discord embed when a player joins the server for the very first time.

OptionTypeDefaultDescription
first-join-message.enableBooleanfalseEnable or disable first join notifications
first-join-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL for first join notifications
first-join-message.embedsList(see above)List of embed objects sent when a new player joins for the first time

These webhooks log account linking events to a Discord channel for audit and moderation purposes.

OptionTypeDefaultDescription
log-link-error-message.enableBooleanfalseEnable logging of failed link attempts
log-link-error-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL for error logs
log-link-error-message.messageString(see above)Message sent when a link attempt fails. Supports %player% and %code% placeholders
OptionTypeDefaultDescription
log-link-success-message.enableBooleanfalseEnable logging of successful account links
log-link-success-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL for success logs
log-link-success-message.messageString(see above)Message sent when an account is successfully linked. Supports %player%, %code%, %discord-name%, and %discord-id%
OptionTypeDefaultDescription
log-unlink-message.enableBooleanfalseEnable logging of account unlinks
log-unlink-message.webhookStringhttps://discord.com/api/webhooks/The Discord webhook URL for unlink logs
log-unlink-message.messageString(see above)Message sent when a player unlinks their account. Supports %player%, %discord-name%, and %discord-id%

Embed Object Properties

Webhook sections that use embeds support the following properties in each embed entry:

PropertyTypeDescription
author.nameStringThe author name displayed at the top of the embed. Supports %player% and %uuid%
author.icon-urlStringURL of the icon displayed next to the author name
colorStringHex color code for the embed sidebar (e.g., "#00ff00" for green)
titleStringOptional embed title
descriptionStringOptional embed description/body text
urlStringOptional URL opened when clicking the title
author.urlStringOptional URL opened when clicking the author name
thumbnail.urlStringOptional thumbnail image URL
image.urlStringOptional large image URL
footer.textStringOptional footer text
footer.icon-urlStringOptional footer icon URL
fieldsListOptional list of fields, each with name, value and inline (Boolean)

Available Placeholders in Webhook Messages

The following placeholders can be used in webhook message fields and embed fields:

PlaceholderDescription
%player%The player's name
%uuid%The player's UUID
%message%The chat message content (chat-message webhook only)
%code%The link verification code (link log webhooks only)
%discord-name%The linked Discord account username (link log webhooks only)
%discord-id%The linked Discord account ID (link log webhooks only)

For the avatar and icon-url fields, services like https://mc-heads.net/avatar/%uuid% and https://mc-heads.net/head/%uuid% provide Minecraft skin renders based on the player UUID.

CommandAliasesPermissionDescription
/linklieressentials.discord.linkLink your Minecraft account to Discord using a verification code
/unlinkdelieressentials.discord.unlinkUnlink your Discord account from your Minecraft account

For the full command list, see Commands & Permissions.

PlaceholderDescription
%zessentials_user_has_discord_linked%Returns true if the player has linked their Discord account, false otherwise

For the full placeholder list, see Placeholders.

Setting Up Webhooks

To create a Discord webhook:

  1. Open your Discord server and navigate to the channel where you want notifications.
  2. Click the gear icon to open Channel Settings.
  3. Go to Integrations > Webhooks.
  4. Click New Webhook.
  5. Configure the webhook name and avatar (optional), then click Copy Webhook URL.
  6. Paste the webhook URL into the corresponding webhook field in the configuration.

Keep your webhook URLs private. Anyone with a webhook URL can send messages to that Discord channel. If a webhook URL is compromised, delete it in Discord and create a new one.

Account Linking

The account linking system connects a player's Minecraft account with their Discord account through a secure code-based verification flow. This requires:

  1. The enable-link-account option set to true in this module's configuration.
  2. The Discord Bot running as a standalone application connected to the same database.

Linking Flow

  1. A player clicks the "Link Account" button on the Discord embed (set up via the bot).
  2. The bot generates a unique verification code and sends it to the player in Discord.
  3. The player runs /link <code> on the Minecraft server.
  4. The accounts are linked in the shared database.
  5. The link event is logged to the configured webhook (if enabled).

Unlinking

Players can unlink their account at any time by running /unlink on the Minecraft server. The unlink event is logged if log-unlink-message is enabled.

For full details on setting up the Discord bot, including database configuration, bot commands, and the complete linking flow diagram, see the Discord Bot page.

Examples

Chat Relay to Discord

Forward all in-game chat to a Discord channel:

chat-message:
  enable: true
  webhook: "https://discord.com/api/webhooks/1234567890/abcdefghijk"
  avatar: "https://mc-heads.net/avatar/%uuid%"
  message: "%message%"
  username: "%player%"

Join/Leave Notifications with Embeds

join-message:
  enable: true
  webhook: "https://discord.com/api/webhooks/1234567890/abcdefghijk"
  embeds:
    - author:
        name: "%player% just logged in"
        icon-url: "https://mc-heads.net/head/%uuid%"
      color: "#00ff00"

left-message:
  enable: true
  webhook: "https://discord.com/api/webhooks/1234567890/abcdefghijk"
  embeds:
    - author:
        name: "%player% just logged out"
        icon-url: "https://mc-heads.net/head/%uuid%"
      color: "#ff0000"

Custom Commands Module

Create your own commands to display links, information, titles or run zMenu actions

Economy Module

Multi-currency economy system with Vault integration

On this page

Source ConfigurationOptionsGeneral OptionsChat Message WebhookJoin Message WebhookLeft Message WebhookFirst Join Message WebhookLink Logging WebhooksLink Error LogLink Success LogUnlink LogEmbed Object PropertiesAvailable Placeholders in Webhook MessagesRelated CommandsRelated PlaceholdersSetting Up WebhooksAccount LinkingLinking FlowUnlinkingExamplesChat Relay to DiscordJoin/Leave Notifications with Embeds
GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.