Settings reference
WelcomeConfig fields, defaults, variables, and extras.
| Setting | Type | Default | What it does |
|---|---|---|---|
welcomeEnabled | boolean | false | Enables the join message. |
welcomeChannelId | snowflake or null | null | Channel used for welcome messages. Required for sending. |
welcomeMessage | string | Welcome {user} to **{server}**! You are member #{memberCount}. | Template sent when a member joins. |
welcomeStyle | TEXT | EMBED | V2 | CANVAS | TEXT | Renderer used for welcome messages. |
welcomeExtras | JSON object string | {} | Style-specific settings for welcome messages. |
goodbyeEnabled | boolean | false | Enables the leave message. |
goodbyeChannelId | snowflake or null | null | Channel used for goodbye messages. Required for sending. |
goodbyeMessage | string | **{user}** has left **{server}**. | Template sent when a member leaves. |
goodbyeStyle | TEXT | EMBED | V2 | CANVAS | TEXT | Renderer used for goodbye messages. |
goodbyeExtras | JSON object string | {} | Style-specific settings for goodbye messages. |
{user}- Join: member mention. Leave: plain username.
{username}- Display name if available, otherwise username.
{userTag}- Username from Discord user data.
{userId}- Discord user ID.
{avatar}- Member avatar URL at size 256, or empty string.
{server}- Server name.
{serverId}- Discord guild ID.
{memberCount}- Current guild member count.
{ordinal}- Member count with suffix, such as
1st,42nd, or113th. {createdAt}- Relative Discord timestamp for account creation, or
unknown. {joinedAt}- Relative Discord timestamp for join time, or current time when unavailable.
Extras accepted by the API include title, color, showAvatar, imageUrl, footer, V2-only thumbnailUrl, spoiler, divider, spacing, images up to 10, links up to 3, and CANVAS-only cardTitle, cardSubtitle, cardBg1, cardBg2, and cardAccent. Hex colors must be #rrggbb.
