Skip to content

Updated endpoint paths after link normalization #7479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8e82316
Updated several links
GeniusTimo Apr 19, 2025
f8de1cc
Reverted a62c908953da8cd224d0904f4c06a9adb0b0290c for 2021-11-23-guil…
GeniusTimo Apr 19, 2025
fe1e87a
[WIP] Added placeholder for links within the request paths
GeniusTimo Apr 19, 2025
31e6ccf
Updated absolute to relative links
GeniusTimo Apr 19, 2025
424e81e
Updated the invite link to the Discord Developers Server
GeniusTimo Apr 19, 2025
7286784
Fixed table indentation
GeniusTimo Apr 19, 2025
8f71342
Changed protocol to https where appropriate
GeniusTimo Apr 20, 2025
65ed3d2
Updated Help Center links to improve maintainability
GeniusTimo Apr 20, 2025
4354cb9
Fixed table indentation once again
GeniusTimo Apr 20, 2025
fe1eeae
Updated links to the developer TOS and policy
GeniusTimo Apr 20, 2025
1867226
Merge branch 'main' into patch-1
GeniusTimo Apr 21, 2025
59fb320
Updated placeholders to new link format
GeniusTimo Apr 22, 2025
2d7666c
Merge branch 'main' into patch-1
GeniusTimo Apr 22, 2025
fc872be
Reverted "Updated Help Center links to improve maintainability"
GeniusTimo Apr 22, 2025
06e82b7
Merge branch 'main' into patch-1
GeniusTimo Apr 22, 2025
3415eed
Wrapped enpoint paths in inline code
GeniusTimo Apr 22, 2025
2e42c67
Changed Route attribute "type" to correct attribute "method"
GeniusTimo Apr 23, 2025
2d7e847
Added link for "{instance_id}"
GeniusTimo Apr 23, 2025
08fcf04
Reverted "Changed protocol to https where appropriate"
GeniusTimo Apr 23, 2025
b58d452
Reverted "Updated links to the developer TOS and policy"
GeniusTimo Apr 23, 2025
57ea157
Merge branch 'main' into patch-1
GeniusTimo Apr 23, 2025
9cbd305
Manually revert some commits and fix merge issues
GeniusTimo Apr 23, 2025
6141e54
Manually reviewed the changes once again and removed the last ones
GeniusTimo Apr 23, 2025
996f0f8
Lets add a trailing whitespace to clean up the diff
GeniusTimo Apr 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ The [Unofficial Discord API server](https://discord.gg/discord-api) is a common

## License

Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/articles/8562894815383-Discord-Developer-Terms-of-Service) for more information about use of Discord’s brand features and APIs.
Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://dis.gd/discord-developer-terms-of-service) for more information about use of Discord’s brand features and APIs.
14 changes: 7 additions & 7 deletions docs/activities/development-guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ The flow for setting up your production application is very similar:
1. If not made yet, create a new application.
2. Enable Activities for your app.
3. Set up the application's [URL Mapping](/docs/activities/development-guides#url-mapping). The URL for your application's html should be set to the `/` route.
4. Follow the instructions for [Launching your Application from the Discord Client](/docs/activities/development-guides#launch-your-application-from-the-discord-client)). Application URL Override should not be enabled.
4. Follow the instructions for [Launching your Application from the Discord Client](/docs/activities/development-guides#launch-your-application-from-the-discord-client). Application URL Override should not be enabled.

This application now uses the same configuration it will use once it is fully published ✨.
![application-test-mode-prod](images/activities/application-test-mode-prod.gif)
Expand Down Expand Up @@ -267,7 +267,7 @@ By default, the SDK will send any console `log`, `warn`, `error`, `info`, and `d

#### Viewing Logs on Desktop

Desktop logs are viewable through the console tab inside a browser's Developer Tools. See the [Troubleshooting Console Log Errors](https://support.discord.com/hc/en-us/articles/115001239472-Troubleshooting-Console-Log-Errors) support article for more information.
Desktop logs are viewable through the console tab inside a browser's Developer Tools. See the [Troubleshooting Console Log Errors](https://support.discord.com/hc/en-us/articles/115001239472) support article for more information.

The Public Test Build (PTB) Discord client also allows inspecting your logs from the `View -> Developer -> Toggle Developer Tools` menu. It can be downloaded at [https://discord.com/downloads](https://discord.com/downloads).

Expand Down Expand Up @@ -356,7 +356,7 @@ Users will see a modal inside the Discord app notifying them whether or not they

### Open Invite Dialog

Getting an Application Channel Invite, as outlined in [these docs](https://discord.com/developers/docs/resources/invite#get-invite), is not granted by any OAuth scopes. Nonetheless, the `openInviteDialog` command is available via the SDK. This command opens the Application Channel Invite UI within the discord client without requiring additional OAuth scopes.
Getting an Application Channel Invite, as outlined in [these docs](/docs/resources/invite#get-invite), is not granted by any OAuth scopes. Nonetheless, the `openInviteDialog` command is available via the SDK. This command opens the Application Channel Invite UI within the discord client without requiring additional OAuth scopes.

This command returns an error when called from DM (Direct Message) contexts, so should only be called in Guild Voice or Text Channels. Similarly, this command returns an error if the user has invalid permissions for the channel, so using `getChannelPermissions` (requires OAuth scope `'guilds.members.read'`) is highly recommended.

Expand Down Expand Up @@ -442,9 +442,9 @@ User Experience

### Setting Up an Entry Point Command

An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV) in Discord.
An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support-apps.discord.com/hc/en-us/articles/26593412574359#h_01J8JFFXHTHT2XP9C1NYPSZR0T) in Discord.

When you enable Activities in your [app's settings](http://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from.
When you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from.

If you want to handle sending messages yourself, you can update the handler to be `APP_HANDLER` (`1`). Details about Entry Point command handlers is in the [Entry Point command documentation](/docs/interactions/application-commands#entry-point-handlers).

Expand Down Expand Up @@ -825,7 +825,7 @@ discordSdk.unsubscribe(Events.ACTIVITY_INSTANCE_PARTICIPANTS_UPDATE, updateParti

### Render Avatars and Names

Check out detailed documentation on where and how Discord stores common image assets [here](https://discord.com/developers/docs/reference#image-formatting-cdn-endpoints).
Check out detailed documentation on where and how Discord stores common image assets [here](/docs/reference#image-formatting-cdn-endpoints).

Here's a basic example for retrieving a user's avatar and username

Expand Down Expand Up @@ -1163,7 +1163,7 @@ All assets loaded by your application will respect [cache headers](https://devel

### Handling Rate Limits

Be sure network requests made by your application's client and server will be able to respect Discord API's rate limiting [as described here](https://discord.com/developers/docs/topics/rate-limits).
Be sure network requests made by your application's client and server will be able to respect Discord API's rate limiting [as described here](/docs/topics/rate-limits).

See [this implementation in the Activity Starter project](https://github.com/discord/embedded-app-sdk-examples/blob/main/discord-activity-starter/packages/server/src/utils.ts) for an example of how to respect the `retry_after` header when you receive a 429 error.

Expand Down
2 changes: 1 addition & 1 deletion docs/change-log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ showTOC: false

# Change Log

Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.com/invite/discord-developers).
Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.gg/discord-developers).

<ChangeLog />
2 changes: 1 addition & 1 deletion docs/change-log/2017-07-24-new-feature-audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: "New Feature: Audit Logs"
date: "2017-07-24"
---

Audit logs are here! Well, they've been here all along, but now we've got [documentation](/docs/resources/audit-log#) about them. Check it out, but remember: with great power comes great responsibility.
Audit logs are here! Well, they've been here all along, but now we've got [documentation](/docs/resources/audit-log) about them. Check it out, but remember: with great power comes great responsibility.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: "Deprecation: Accept Invite Endpoint"
date: "2018-01-23"
---

The [Accept Invite](/docs/resources/invite#) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](/docs/resources/guild#add-guild-member) endpoint should be used in its place.
The [Accept Invite](/docs/resources/invite) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](/docs/resources/guild#add-guild-member) endpoint should be used in its place.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: "Enhancement: New Message Properties"
date: "2018-02-05"
---

Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements.
Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212) and previous Rich Presence enhancements.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: "Added Info Around Nitro Boosting Experiment"
date: "2019-05-29"
---

Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting). This includes the addition of a few [message types](/docs/resources/message#message-object-message-types), as well as some [new fields on guilds](/docs/resources/guild#guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change.
Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352). This includes the addition of a few [message types](/docs/resources/message#message-object-message-types), as well as some [new fields on guilds](/docs/resources/guild#guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change.
2 changes: 1 addition & 1 deletion docs/change-log/2019-08-12-more-precise-rate-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: "More Precise Rate Limits"
date: "2019-08-12"
---

You can now get more precise rate limit reset times, via a new request header. Check out the [rate limits](/docs/topics/rate-limits#) documentation for more information.
You can now get more precise rate limit reset times, via a new request header. Check out the [rate limits](/docs/topics/rate-limits) documentation for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Slash Commands and Interactions"
date: "2020-12-15"
---

Slash Commands are here! There's a *lot* to cover, so go check out specific documentation under [Slash Commands](/docs/interactions/application-commands#).
Slash Commands are here! There's a *lot* to cover, so go check out specific documentation under [Slash Commands](/docs/interactions/application-commands).

Slash Commands include some new features for webhooks as well:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: "2021-05-26"

Message components are now available with our first two components: a layout-based `ActionRow` and...buttons!

You can now include buttons on messages sent by your app, whether they're bot messages or responses to interactions. [Learn more about message components](/docs/interactions/message-components#).
You can now include buttons on messages sent by your app, whether they're bot messages or responses to interactions. [Learn more about message components](/docs/interactions/message-components).

The addition of message components means new fields and response types:

Expand Down
2 changes: 1 addition & 1 deletion docs/change-log/2021-06-30-select-menu-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ date: "2021-06-30"

Select Menus are now part of the components API! They're the greatest thing since the invention of buttons yesterday. Select menus allow you to offer users a choice of one or many options in a friendly UI-based way.

Select menus can be used like other [message components](/docs/interactions/message-components#). Learn all the specifics in the [documentation](/docs/interactions/message-components#select-menus).
Select menus can be used like other [message components](/docs/interactions/message-components). Learn all the specifics in the [documentation](/docs/interactions/message-components#select-menus).
8 changes: 4 additions & 4 deletions docs/change-log/2021-11-23-guild-scheduled-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ date: "2021-11-23"

#### Nov 18, 2021

* Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}/users`
* Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}`
* Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}`
* Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users`
* Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}`
* Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}`
* More details and clarification for the guild scheduled events feature.
* Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}/users`
* Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users`

#### Nov 15, 2021

Expand Down
2 changes: 1 addition & 1 deletion docs/change-log/2022-02-14-api-v10.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ date: "2022-02-14"
#### Upcoming changes

* API v6 and v7 will be decommissioned **in early 2023**
* `MESSAGE_CONTENT` is becoming a privileged intent for verified bots in 75+ servers **on August 31, 2022**. Read details in [the FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Privileged-Intent-FAQ) or follow [the guide](/docs/tutorials/upgrading-to-application-commands) on updating your app.
* `MESSAGE_CONTENT` is becoming a privileged intent for verified bots in 75+ servers **on August 31, 2022**. Read details in [the FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055) or follow [the guide](/docs/tutorials/upgrading-to-application-commands) on updating your app.
* The `summary` field for applications will be removed in the next API version (v11)
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: "2022-09-01"
breaking: true
---

As of today, [message content](/docs/events/gateway#message-content-intent) is a privileged intent for all verified apps *and* apps eligible for verification. More details about why it's becoming a privileged intent and how to apply for it is in the [Help Center FAQ](https://support-dev.discord.com/hc/articles/4404772028055-Message-Content-Privileged-Intent-FAQ).
As of today, [message content](/docs/events/gateway#message-content-intent) is a privileged intent for all verified apps *and* apps eligible for verification. More details about why it's becoming a privileged intent and how to apply for it is in the [Help Center FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055).

Any app that does not have the message content intent configured in its app's settings within the Developer Portal will receive empty values in fields that expose message content across Discord's APIs (including the `content`, `embeds`, `attachments`, and `components` fields). These restrictions do not apply for messages that a bot or app sends, in DMs that it receives, or in messages in which it is mentioned.

Expand Down
2 changes: 1 addition & 1 deletion docs/change-log/2022-09-14-forum-channels-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ date: "2022-09-14"

Forum channels ([`GUILD_FORUM` or `15`](/docs/resources/channel#channel-object-channel-types)) have been released to all community servers. `GUILD_FORUM` channels are a new channel type that only supports threads, which display differently than in text (`GUILD_TEXT`) channels.

Check out the [forums topic](/docs/topics/threads#forums) for more information on the relevant APIs and technical details, and the [Forums FAQ](https://support.discord.com/hc/en-us/articles/6208479917079-Forum-Channels-FAQ#h_01G69FJQWTWN88HFEHK7Z6X79N) for more about the feature.
Check out the [forums topic](/docs/topics/threads#forums) for more information on the relevant APIs and technical details, and the [Forums FAQ](https://support.discord.com/hc/en-us/articles/6208479917079#h_01JAZAWCX4DXYK26BKT49DXMAQ) for more about the feature.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: "Add Auto Moderation custom_message Action Metadata Field"
date: "2023-02-24"
---

Add new `custom_message` [action metadata](/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata) for the `BLOCK_MESSAGE` [action type](/docs/resources/auto-moderation#auto-moderation-action-object-action-types)). You can now specify a custom string for every Auto Moderation rule that will be shown to members whenever the rule blocks their message. This can be used as an additional explanation for why a message was blocked and as a chance to help members understand your server's rules and guidelines.
Add new `custom_message` [action metadata](/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata) for the `BLOCK_MESSAGE` [action type](/docs/resources/auto-moderation#auto-moderation-action-object-action-types). You can now specify a custom string for every Auto Moderation rule that will be shown to members whenever the rule blocks their message. This can be used as an additional explanation for why a message was blocked and as a chance to help members understand your server's rules and guidelines.
4 changes: 2 additions & 2 deletions docs/change-log/2023-05-03-unique-usernames-on-discord.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ date: "2023-05-03"
---

:::warn
Bot users will stay on the legacy username system for now. More details can be found on the [Developer Help Center article](https://dis.gd/app-usernames).
Bot users will stay on the legacy username system for now. More details can be found on the [Developer Help Center article](https://support-dev.discord.com/hc/en-us/articles/13667755828631).
:::

Discord’s username system is changing. Discriminators are being removed and new, unique usernames and display names are being introduced. You can read more details about how changes to the username system affects non-bot users in the [general Help Center article](https://dis.gd/usernames). To learn how it impacts bot users specifically, you can read the [Developer Help Center article](https://dis.gd/app-usernames).
Discord’s username system is changing. Discriminators are being removed and new, unique usernames and display names are being introduced. You can read more details about how changes to the username system affects non-bot users in the [general Help Center article](https://support.discord.com/hc/en-us/articles/12620128861463). To learn how it impacts bot users specifically, you can read the [Developer Help Center article](https://support-dev.discord.com/hc/en-us/articles/13667755828631).

This changelog focuses only on the technical changes to be aware of to update your app's code.

Expand Down
Loading