Skip to main content
You can customize the appearance of webhook messages by configuring colors, emojis, and webhook identity overrides in your config.js file.

Webhook identity

Override the default username and avatar shown when the webhook posts messages to Discord.
overrideUsername
string | null
default:"null"
Custom username displayed on webhook messages. When set to null, the webhook uses the username from the message payload.The override is applied to all messages sent through the webhook, including stat notifications and status updates.
overrideAvatarURL
string | null
default:"null"
Custom avatar image URL displayed on webhook messages. When set to null, the webhook uses the avatar URL from the message payload.Must be a valid image URL (e.g., https://example.com/avatar.png).

Example configuration

const config = {
    "overrideUsername": null,
    "overrideAvatarURL": null,
    // ...
};
When you set an override, it applies to all webhook messages, including status updates like “Connected” and “Reconnecting”, not just stat notifications.

Embed colors

Customize the embed border colors for different message types. Colors use hexadecimal format.
colors.success
string
default:"#6ab183"
Color used for positive status messages, including:
  • WebSocket connected to gateway
  • Stat tracking enabled
Default: #6ab183 (green)
colors.error
string
default:"#d85a4b"
Color used for error and warning messages, including:
  • Stat tracking disabled
  • Authentication errors (missing, invalid, or deleted token)
  • Duplicate connection errors
Default: #d85a4b (red)
colors.none
string
default:"#777f8d"
Color used for neutral status messages, including:
  • Reconnecting to gateway
Default: #777f8d (gray)

Example configuration

const config = {
    "colors": {
        "success": "#6ab183",
        "error": "#d85a4b",
        "none": "#777f8d"
    },
    // ...
};
You can use any valid hex color code. Use a color picker tool to find hex codes for your preferred colors.

Emojis

Customize the emojis displayed in status message embeds. You can use Discord custom emojis or standard Unicode emojis.
emojis.success
string
default:"<:green_tick:1365702693326422026>"
Emoji displayed in positive status messages (connected, enabled).Default: Custom green checkmark emoji
emojis.error
string
default:"<:red_tick:1365702694727188491>"
Emoji displayed in error and warning messages (disabled, authentication errors).Default: Custom red X emoji
emojis.none
string
default:"<:gray_tick:1365702690985738390>"
Emoji displayed in neutral status messages (reconnecting).Default: Custom gray checkmark emoji

Using custom Discord emojis

To use a custom emoji from your Discord server:
  1. Type the emoji in any Discord channel with a backslash: \:emoji_name:
  2. Discord will show the full emoji code: <:emoji_name:123456789012345678>
  3. Copy this code into your config

Using Unicode emojis

You can also use standard Unicode emojis:
const config = {
    "emojis": {
        "success": "✅",
        "error": "❌",
        "none": "⚪"
    },
    // ...
};
When using custom Discord emojis, the webhook must have access to those emojis. If the emojis are from a different server where the webhook doesn’t exist, they may not display correctly.

Complete customization example

const config = {
    // AUTHENTICATION (REQUIRED)
    "token": "YOUR_API_TOKEN_HERE",
    "webhookURL": "YOUR_WEBHOOK_URL_HERE",

    // WEBHOOK USER (OPTIONAL)
    "overrideUsername": "Sol's Stats Bot",
    "overrideAvatarURL": "https://i.imgur.com/example.png",

    "colors": {
        "success": "#00ff00",
        "error": "#ff0000",
        "none": "#888888"
    },

    "emojis": {
        "success": "✅",
        "error": "❌",
        "none": "⚪"
    },

    // ... other configuration
};

Build docs developers (and LLMs) love