Welcome and goodbye

As soon as a member joins the server, the bot runs these steps one after the other:

1. It posts the join and invite logs, if those log channels are set (see Logs).
2. It runs the member through the anti-raid protections and raid mode. If one of them kicks the member, everything stops there.
3. If the captcha is on, it waits for the member to type the code (up to 3 minutes). If they fail, they are kicked and everything stops.
4. It sends the welcome message in the join channel (and by direct message if you wrote a custom message).
5. It gives the welcome roles.

The message is posted in the join channel: Join Announcement Channel on the website, Join/Leave Channel in /config. Without a channel, no message is posted; welcome roles are still given, as long as you have not written a custom message (see Common problems). The text is written in the server language.

Until you write a custom message, the bot uses its default text:

• the title "New Member!";
• "Welcome to server name!", then a greeting with the member's display name (their server nickname, otherwise their Discord name) and the total number of members;
• the member's avatar as a thumbnail on the right;
• below it, the welcome card (see Welcome and goodbye cards).

The default text does not mention the member, so they get no notification. To mention them, write a custom message with the {user} variable.

The custom message (Custom Welcome Message on the website, Custom Message in /config) replaces the default title and text. The avatar and the card stay. It accepts 2000 characters and Discord formatting (### for a heading, **bold**, -# for small text…).

Variables

Example message:

### Welcome {user} to **{guildName}**! ☕
You are member number **{guildMemberCount}**, make yourself at home and introduce yourself!

• An unknown variable stays as it is in the message. Careful: {memberCount} only exists in the default text, use {guildMemberCount}.
• For an emoji, paste the character itself (☕) or the Discord syntax of one of your server's emojis (<:name:id>).
• On the website, the variable tags are inserted with one click, and Use default message adds a template close to the bot's text (in French, whatever your language).
• In /config the field is required: to go back to the default text, clear the message from the website.

The direct message

With a custom message, the bot also sends the message to the new member by direct message: the same text, their avatar and the card, followed by a "Sent by server name" button that opens the join channel. If the member has closed their DMs, sending fails silently. With the default text, no direct message is sent.

Welcome roles are added to the member right after the welcome message, all at once. Discord's audit log shows the reason "Assigning welcome roles" (in the server language).

For a role to be given:

• the bot needs the Manage Roles permission;
• the role must be below the bot's highest role and not managed by an integration (a bot's role, the Booster role…);
• the role must still exist: a deleted role is simply skipped.

In /config you can pick up to 25 roles, and only valid roles are accepted. On the website, the list offers the roles not managed by an integration, with no limit.

Roles are not given when the member was kicked by the anti-raid, raid mode or the captcha.

The captcha is part of the anti-raid (Security Captcha). It is active when the anti-raid is on, the captcha protection is on and a text captcha channel is set. It is configured on the Security and anti-raid page of the website or in /config → Antiraid.

When it is active:

1. the bot posts in the captcha channel an image with a 6-character code and mentions the new member;
2. the member must type that code in the channel before the countdown ends (3 minutes); their messages are deleted as they go;
3. if they succeed, the bot sends the welcome message, then gives the welcome roles;
4. if they fail or don't answer in time, they are kicked from the server and receive a direct message.

During those 3 minutes the member has no welcome role yet, so the captcha channel must be visible to @everyone. Every protection is detailed on the Anti-raid and security page.

When a member leaves the server (on their own, kicked or banned), the bot posts a goodbye message in the leave channel: Leave Announcement Channel on the website. It can be the same channel as the join channel or a different one.

• Without a leave channel, nothing is posted. As for arrivals, it must be a text channel.
• No direct message is sent: the person is no longer on the server.
• The default text shows the title "A member left", the member's display name, a thank-you line and the number of remaining members, with their avatar and the goodbye card.

The custom goodbye message can only be set on the website. It accepts the same variables as the welcome message; there, {guildMemberCount} gives the number of remaining members.

Every message comes with a 1200 × 400 pixel image generated by the bot, in the server language.

Emojis and characters the font doesn't know are removed from names. If nothing is left of the username, the title simply becomes "WELCOME!" or "GOODBYE!".

The card background

For the welcome card, the bot takes the first available background:

1. the member's own background for their welcome cards, if they picked one in their website preferences (an option of the personal plans, see The dashboard);
2. the server image (Welcome Card Banner & Image on the website, Image in /config);
3. the Dispatch.IO default image.

For the goodbye card, it is the server's goodbye image (Goodbye Card Banner & Image, website only), otherwise the default image. Personal backgrounds do not apply to goodbyes.

The dark veil (on by default, website only) darkens the image so the text stays readable. Turn it off if your image is already dark. The welcome image is also the fallback background of level and flame cards.

• Messages and cards use the server language (Language and time zone).
• The module has no Premium-plan limit. Only members' personal backgrounds depend on their personal plan (see Premium plans and limits).
• An image changed from /config can take up to one hour to show on the cards.

Test before opening the doors

On the website, the Test Welcome Message and Test Goodbye Message buttons make the bot send the real message, as if you had just joined or left:

• you must save a channel first: the test uses the saved configuration, not the form being edited;
• with a custom message, you also get the direct message;
• no role is given during a test;
• one test per server every 60 seconds.

The card preview shown on the website is generated by the bot itself: if it doesn't appear, check that the bot is online.

Learn more: Bot configuration, Permissions and roles and Troubleshooting.