> ## Documentation Index
> Fetch the complete documentation index at: https://heimdall.gg/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome Messages

> Sending a formatted message to new members when they join your server.

The welcome plugin posts a message to a designated channel whenever a member joins your server. The message is fully customisable - you can write it as plain text or as a rich embed, and use variables to include the member's name, the server name, and the current member count.

![Community Welcome](https://mintcdn.com/bifrost-77/cWdWsyIXuC0bGrEs/images/Community_Welcome.png?fit=max\&auto=format\&n=cWdWsyIXuC0bGrEs\&q=85\&s=bbac050743e3da02b660b8471c331163)

## Setting up

```text theme={null}
/welcome setup
```

Running `/welcome setup` opens a configuration modal where you define the welcome channel and compose your message. Alternatively, configure everything through the dashboard at [**Welcome**](https://bot.bifrost.gg/go/welcome).

### Dashboard configuration

Navigate to [**Welcome**](https://bot.bifrost.gg/go/welcome) in the dashboard sidebar. The configuration page has:

| Setting | Description |
| - | - |
| **Channel** | The channel where welcome messages are posted |
| **Message content** | Plain text or embed content for the welcome message |
| **Embed toggle** | Send the message as a rich embed with colour and fields |
| **Embed colour** | The left-side colour of the embed |

## Available variables

Variables are placeholders in your message that the bot fills in at send time. Wrap variables in curly braces:

| Variable | Replaced with |
| - | - |
| `{user}` | A mention of the new member (`@Username`) |
| `{user.name}` | The member's display name (no mention) |
| `{user.id}` | The member's Discord user ID |
| `{server}` | Your server's name |
| `{server.count}` | The total number of members after the join |
| `{server.id}` | Your server's ID |

### Example message

```text theme={null}
Welcome to {server}, {user}! You are member number {server.count}.
Please read <#channel-id> before getting started.
```

## Testing the welcome message

```text theme={null}
/welcome test
```

Posts a preview of your welcome message to the current channel using your own account as the test member. Useful for verifying formatting and variables before the next real join.

## Viewing the current configuration

```text theme={null}
/welcome view
```

Displays the current welcome message configuration without triggering a test send.

## Removing the welcome message

```text theme={null}
/welcome remove
```

Disables the welcome message. The configuration is retained so you can re-enable it later.

## Required permissions

| Action | Permission key |
| - | - |
| Viewing welcome configuration | `welcome.view_config` |
| Editing welcome configuration | `welcome.manage_config` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.