diff --git a/developers/reference.mdx b/developers/reference.mdx index c674d8fa07..709f46559e 100644 --- a/developers/reference.mdx +++ b/developers/reference.mdx @@ -353,30 +353,32 @@ Discord uses ids and hashes to render images in the client. These hashes can be **CDN Endpoints** -| Type | Path | Supports | -|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| Custom Emoji | emojis/[emoji_id](/developers/resources/emoji#emoji-object).png \*\*\*\*\* | PNG, JPEG, WebP, GIF | -| Guild Icon | icons/[guild_id](/developers/resources/guild#guild-object)/[guild_icon](/developers/resources/guild#guild-object).png \* | PNG, JPEG, WebP, GIF | -| Guild Splash | splashes/[guild_id](/developers/resources/guild#guild-object)/[guild_splash](/developers/resources/guild#guild-object).png | PNG, JPEG, WebP | -| Guild Discovery Splash | discovery-splashes/[guild_id](/developers/resources/guild#guild-object)/[guild_discovery_splash](/developers/resources/guild#guild-object).png | PNG, JPEG, WebP | -| Guild Banner | banners/[guild_id](/developers/resources/guild#guild-object)/[guild_banner](/developers/resources/guild#guild-object).png \* | PNG, JPEG, WebP, GIF | -| User Banner | banners/[user_id](/developers/resources/user#user-object)/[user_banner](/developers/resources/user#user-object).png \* | PNG, JPEG, WebP, GIF | -| Default User Avatar | embed/avatars/[index](/developers/resources/user#user-object).png \*\* \*\*\* | PNG | -| User Avatar | avatars/[user_id](/developers/resources/user#user-object)/[user_avatar](/developers/resources/user#user-object).png \* | PNG, JPEG, WebP, GIF | -| Guild Member Avatar | guilds/[guild_id](/developers/resources/guild#guild-object)/users/[user_id](/developers/resources/user#user-object)/avatars/[member_avatar](/developers/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF | -| Avatar Decoration | avatar-decoration-presets/[avatar_decoration_data_asset](/developers/resources/user#avatar-decoration-data-object).png | PNG | -| Application Icon | app-icons/[application_id](/developers/resources/application#application-object)/[icon](/developers/resources/application#application-object).png | PNG, JPEG, WebP | -| Application Cover | app-icons/[application_id](/developers/resources/application#application-object)/[cover_image](/developers/resources/application#application-object).png | PNG, JPEG, WebP | -| Application Asset | app-assets/[application_id](/developers/resources/application#application-object)/[asset_id](/developers/events/gateway-events#activity-object-activity-assets).png | PNG, JPEG, WebP | -| Achievement Icon | app-assets/[application_id](/developers/resources/application#application-object)/achievements/[achievement_id](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Achievements.md#user-achievement-struct)/icons/[icon_hash](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Achievements.md#user-achievement-struct).png | PNG, JPEG, WebP | -| Store Page Asset | app-assets/[application_id](/developers/resources/application#application-object)/store/asset_id | PNG, JPEG, WebP | -| Sticker Pack Banner | app-assets/710982414301790216/store/[sticker_pack_banner_asset_id](/developers/resources/sticker#sticker-pack-object).png | PNG, JPEG, WebP | -| Team Icon | team-icons/[team_id](/developers/topics/teams#data-models-team-object)/[team_icon](/developers/topics/teams#data-models-team-object).png | PNG, JPEG, WebP | -| Sticker | stickers/[sticker_id](/developers/resources/sticker#sticker-object).png \*\*\* \*\*\*\* | PNG, Lottie, GIF | -| Role Icon | role-icons/[role_id](/developers/topics/permissions#role-object)/[role_icon](/developers/topics/permissions#role-object).png | PNG, JPEG, WebP | -| Guild Scheduled Event Cover | guild-events/[scheduled_event_id](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/[scheduled_event_cover_image](/developers/resources/guild-scheduled-event#guild-scheduled-event-object).png | PNG, JPEG, WebP | -| Guild Member Banner | guilds/[guild_id](/developers/resources/guild#guild-object)/users/[user_id](/developers/resources/user#user-object)/banners/[member_banner](/developers/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF | -| Guild Tag Badge | guild-tag-badges/[guild_id](/developers/resources/guild#guild-object)/[badge_hash](/developers/resources/user#user-object-user-primary-guild).png | PNG, JPEG, WebP | +| Type | Path | Supports | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Custom Emoji | emojis/[emoji_id](/developers/resources/emoji#emoji-object).png \*\*\*\*\* | PNG, JPEG, WebP, GIF | +| Guild Icon | icons/[guild_id](/developers/resources/guild#guild-object)/[guild_icon](/developers/resources/guild#guild-object).png \* | PNG, JPEG, WebP, GIF | +| Guild Splash | splashes/[guild_id](/developers/resources/guild#guild-object)/[guild_splash](/developers/resources/guild#guild-object).png | PNG, JPEG, WebP | +| Guild Discovery Splash | discovery-splashes/[guild_id](/developers/resources/guild#guild-object)/[guild_discovery_splash](/developers/resources/guild#guild-object).png | PNG, JPEG, WebP | +| Guild Banner | banners/[guild_id](/developers/resources/guild#guild-object)/[guild_banner](/developers/resources/guild#guild-object).png \* | PNG, JPEG, WebP, GIF | +| User Banner | banners/[user_id](/developers/resources/user#user-object)/[user_banner](/developers/resources/user#user-object).png \* | PNG, JPEG, WebP, GIF | +| Default User Avatar | embed/avatars/[index](/developers/resources/user#user-object).png \*\* \*\*\* | PNG | +| User Avatar | avatars/[user_id](/developers/resources/user#user-object)/[user_avatar](/developers/resources/user#user-object).png \* | PNG, JPEG, WebP, GIF | +| Guild Member Avatar | guilds/[guild_id](/developers/resources/guild#guild-object)/users/[user_id](/developers/resources/user#user-object)/avatars/[member_avatar](/developers/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF | +| Avatar Decoration | avatar-decoration-presets/[avatar_decoration_data_asset](/developers/resources/user#avatar-decoration-data-object).png | PNG | +| Application Icon | app-icons/[application_id](/developers/resources/application#application-object)/[icon](/developers/resources/application#application-object).png | PNG, JPEG, WebP | +| Application Cover | app-icons/[application_id](/developers/resources/application#application-object)/[cover_image](/developers/resources/application#application-object).png | PNG, JPEG, WebP | +| Application Asset | app-assets/[application_id](/developers/resources/application#application-object)/[asset_id](/developers/events/gateway-events#activity-object-activity-assets).png | PNG, JPEG, WebP | +| Achievement Icon | app-assets/[application_id](/developers/resources/application#application-object)/achievements/[achievement_id](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Achievements.md#user-achievement-struct)/icons/[icon_hash](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Achievements.md#user-achievement-struct).png | PNG, JPEG, WebP | +| Store Page Asset | app-assets/[application_id](/developers/resources/application#application-object)/store/asset_id | PNG, JPEG, WebP | +| Sticker Pack Banner | app-assets/710982414301790216/store/[sticker_pack_banner_asset_id](/developers/resources/sticker#sticker-pack-object).png | PNG, JPEG, WebP | +| Team Icon | team-icons/[team_id](/developers/topics/teams#data-models-team-object)/[team_icon](/developers/topics/teams#data-models-team-object).png | PNG, JPEG, WebP | +| Sticker | stickers/[sticker_id](/developers/resources/sticker#sticker-object).png \*\*\* \*\*\*\* | PNG, Lottie, GIF | +| Role Icon | role-icons/[role_id](/developers/topics/permissions#role-object)/[role_icon](/developers/topics/permissions#role-object).png | PNG, JPEG, WebP | +| Guild Scheduled Event Cover | guild-events/[scheduled_event_id](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/[scheduled_event_cover_image](/developers/resources/guild-scheduled-event#guild-scheduled-event-object).png | PNG, JPEG, WebP | +| Guild Member Banner | guilds/[guild_id](/developers/resources/guild#guild-object)/users/[user_id](/developers/resources/user#user-object)/banners/[member_banner](/developers/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF | +| Guild Tag Badge | guild-tag-badges/[guild_id](/developers/resources/guild#guild-object)/[badge_hash](/developers/resources/user#user-object-user-primary-guild).png | PNG, JPEG, WebP | +| Guild New Member Action Icon | /new-member-actions/[channel_id](/developers/resources/channel#channel-object)/[action_icon](/developers/resources/guild#guild-home-settings-object-new-member-action-structure).png | PNG, JPEG, WebP | +| Guild Resource Channel Icon | /resource-channels/[channel_id](/developers/resources/channel#channel-object)/[channel_icon](/developers/resources/guild#guild-home-settings-object-resource-channel-structure).png | PNG, JPEG, WebP | \* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in an animated format (example: `a_1269e74af4df7417b13759eae50c83dc`). These images can be retrieved as animated WebP using the `.webp` file extension and `?animated=true` querystring parameter. diff --git a/developers/resources/audit-log.mdx b/developers/resources/audit-log.mdx index 3f858926da..7b9e15b5ee 100644 --- a/developers/resources/audit-log.mdx +++ b/developers/resources/audit-log.mdx @@ -151,8 +151,8 @@ You should assume that your app may run into any field for the changed object, t | ONBOARDING_PROMPT_DELETE | 165 | Guild Onboarding Question was deleted | [Onboarding Prompt Structure](/developers/resources/guild#guild-onboarding-object-onboarding-prompt-structure) | | ONBOARDING_CREATE | 166 | Guild Onboarding was created | [Guild Onboarding](/developers/resources/guild#guild-onboarding-object) | | ONBOARDING_UPDATE | 167 | Guild Onboarding was updated | [Guild Onboarding](/developers/resources/guild#guild-onboarding-object) | -| HOME_SETTINGS_CREATE | 190 | Guild Server Guide was created | | -| HOME_SETTINGS_UPDATE | 191 | Guild Server Guide was updated | | +| HOME_SETTINGS_CREATE | 190 | Guild Server Guide was created | [Guild Home Settings](/developers/resources/guild#guild-home-settings-object) | +| HOME_SETTINGS_UPDATE | 191 | Guild Server Guide was updated | [Guild Home Settings](/developers/resources/guild#guild-home-settings-object) | | VOICE_CHANNEL_STATUS_UPDATE | 192 | A voice channel status was updated by a user | | | VOICE_CHANNEL_STATUS_DELETE | 193 | A voice channel status was deleted by a user | | diff --git a/developers/resources/guild.mdx b/developers/resources/guild.mdx index f97c43458a..25be813d2e 100644 --- a/developers/resources/guild.mdx +++ b/developers/resources/guild.mdx @@ -742,6 +742,60 @@ We are making significant changes to the Membership Screening API specifically r } ``` +### Guild Home Settings Object + +Represents the [server guide](https://support.discord.com/hc/en-us/articles/13497665141655-Server-Guide-FAQ) for a guild. + + +###### Guild Home Settings Structure + +| Field | Type | Description | +|--------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| +| guild_id | snowflake | the ID of the guild the home settings are for | +| enabled | boolean | whether home settings are enabled in the guild | +| welcome_message? | [welcome message](/developers/resources/guild#guild-home-settings-object-welcome-message-structure) object | the message shown to new members who join the guild | +| new_member_actions | array of [new memeber action](/developers/resources/guild#guild-home-settings-object-new-member-action-structure) objects | the actions that new members are prompted to complete | +| resource_channels | array of [resource channel](/developers/resources/guild#guild-home-settings-object-resource-channel-structure) objects | the read-only resource channels that are shown to new members | + + +###### New Member Action Structure + +| Field | Type | Description | +|-------------|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------| +| title | string | the title of the action | +| channel_id | snowflake | the ID of the channel where the action should be completed | +| action_type | [action type](/developers/resources/guild#guild-home-settings-object-action-type) | the type of the action | +| description | string | the description of the action | +| emoji? | partial [emoji](/developers/resources/emoji#emoji-object) object | the emoji of the action | +| icon? | string | the [icon hash](/developers/reference#image-formatting) of the action | + + +###### Resource Channel Structure + +| Field | Type | Description | +|-------------|------------------------------------------------------------------|---------------------------------------------------------------------------------| +| title | string | the title of the resource channel | +| channel_id | snowflake | the ID of the channel the resource channel references | +| description | string | the description of the resource channel | +| emoji? | partial [emoji](/developers/resources/emoji#emoji-object) object | the emoji of the resource channel | +| icon? | string | the [icon hash](/developers/reference#image-formatting) of the resource channel | + + +###### Welcome Message Structure + +| Field | Type | Description | +|------------------------|-------------------------------------|-----------------------------------------------------------------------------| +| message | string | the message shown to new members who join the guild | +| author_ids | array of snowflakes | the IDs of the users who are credited as the authors of the welcome message | + + +###### Action Type + +| Name | Value | Description | +|-------|-------|-----------------------------------------------| +| VIEW | 0 | The member must view the channel | +| TALK | 1 | The member must send a message in the channel | + ## Get Guild /guilds/[\{guild.id\}](/developers/resources/guild#guild-object) @@ -1514,3 +1568,12 @@ Both `invites_disabled_until` and `dms_disabled_until` can be enabled for a maxi | dms_disabled_until? | ?ISO8601 timestamp \* | when direct messages will be enabled again | \* Supplying `null` disables the action. + +## Get Guild New Member Welcome +/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/new-member-welcome + + +If the new member welcome experience has been disabled, and the application does not have the `MANAGE_GUILD` permission, the endpoint will unexpectedly return a 204 empty response. + + +Returns the [Home Settings](/developers/resources/guild#guild-onboarding-object) object for the guild. \ No newline at end of file