Onboarding & Welcome Screen
Structures for a guildâs onboarding flow and welcome screen. Fetch the raw payloads with client.guilds.fetchOnboarding(guildId) and client.guilds.fetchWelcomeScreen(guildId); wrap them with new GuildOnboarding(raw) / new GuildWelcomeScreen(raw). Edit them with editOnboarding() (needs Manage Guild and Manage Roles) and editWelcomeScreen() (needs Manage Guild and the Community feature).
GuildOnboarding
Section titled âGuildOnboardingâ| Property | Type | Description |
|---|---|---|
id |
string |
The guildâs ID. |
prompts |
OnboardingPrompt[] |
The questions new members answer. |
defaultChannelIds |
string[] |
Channels every new member is given. |
enabled |
boolean |
Whether onboarding is on. |
mode |
number |
Discordâs onboarding mode. |
OnboardingPrompt
Section titled âOnboardingPromptâ| Property | Type | Description |
|---|---|---|
id |
string |
Prompt ID. |
type |
number |
Prompt type (multiple choice or dropdown). |
title |
string |
The question. |
options |
OnboardingPromptOption[] |
The answers. |
singleSelect |
boolean |
Whether only one answer may be chosen. |
required |
boolean |
Whether the prompt must be answered. |
inOnboarding |
boolean |
Whether it is shown during onboarding, not only in Channels & Roles. |
OnboardingPromptOption
Section titled âOnboardingPromptOptionâ| Property | Type | Description |
|---|---|---|
id |
string |
Option ID. |
title |
string |
The answerâs label. |
description |
string | null |
Optional description. |
emoji |
APIPartialEmoji | undefined |
The answerâs emoji. |
channelIds |
string[] |
Channels granted by this answer. |
roleIds |
string[] |
Roles granted by this answer. |
GuildWelcomeScreen
Section titled âGuildWelcomeScreenâ| Property | Type | Description |
|---|---|---|
description |
string | null |
The welcome message. |
channels |
WelcomeScreenChannel[] |
The channels it recommends. |
WelcomeScreenChannel
Section titled âWelcomeScreenChannelâ| Property | Type | Description |
|---|---|---|
channelId |
string |
The recommended channel. |
description |
string |
Why it is recommended. |
emojiId / emojiName |
string | null |
The channelâs emoji. |