Skip to content
Merged
Show file tree
Hide file tree
Changes from 16 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.
10 changes: 5 additions & 5 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 @@ -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 @@ -444,7 +444,7 @@ User Experience

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.

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.
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
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.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ Starting today, eligible US-based developers can monetize their verified apps wi
* [Delete Test Entitlement](/docs/resources/entitlement#delete-test-entitlement) `DELETE /applications/<application.id>/entitlements/<entitlement.id>`
* [Gateway Events](/docs/events/gateway-events#entitlements) for working with entitlements: `ENTITLEMENT_CREATE`, `ENTITLEMENT_UPDATE`, `ENTITLEMENT_DELETE`
* New [`PREMIUM_REQUIRED (10)` interaction response type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type) is available to prompt users to upgrade
* New `entitlements` field, which is an array of [entitlement](/docs/resources/entitlement#) objects, available in interaction data payloads when [receiving and responding to interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure)
* New `entitlements` field, which is an array of [entitlement](/docs/resources/entitlement) objects, available in interaction data payloads when [receiving and responding to interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure)

To learn more about eligibility details and how to enable monetization for your app, check out the [Monetization Overview](/docs/monetization/overview).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To limit impact on your app, please make sure you are making calls to `discord.c

This does **not** apply for `cdn.discordapp.com`.

Refer to the [API Reference](https://discord.com/developers/docs/reference) for more info on which url(s) to use when building on the REST API
Refer to the [API Reference](/docs/reference) for more info on which url(s) to use when building on the REST API

* [February 14, 2022 Change Log](https://discord.com/developers/docs/change-log#feb-14-2022): Requests to v10 and higher will no longer be supported on `discordapp.com` (this does not affect `cdn.discordapp.com`)
* [February 14, 2022 Change Log](/docs/change-log#api-v10): Requests to v10 and higher will no longer be supported on `discordapp.com` (this does not affect `cdn.discordapp.com`)
* [May 4, 2020 #api-announcements](https://discord.com/channels/613425648685547541/697138785317814292/706944540971630662)
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Discord Developers can now build Activities!
Activities are interactive, multiplayer experiences that run in an iframe in Discord. In order to make the communication between your experience and Discord, we've introduced the Embedded App SDK to assist in communicating between your app and the Discord client.

* New [Discord Activities](/docs/activities/overview) developer docs with a tutorial, code samples, development guides, and design principles.
* The Embedded App SDK is now available via [npm](https://npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](http://github.com/discord/embedded-app-sdk).
* The Embedded App SDK is now available via [npm](https://npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk).
* The [Embedded App SDK Reference](/docs/developer-tools/embedded-app-sdk) is now available.

To learn more about how to get started building your own Activity, check out the [Activities Overview](/docs/activities/overview).
2 changes: 1 addition & 1 deletion docs/change-log/2024-08-26-entry-point-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ More details about Entry Point commands can be found in the [Application Command

### Default Entry Point Commands

Starting today, 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) called "Launch" will automatically be created for your app. This can be customized or deleted like other commands if you want to update the name or handler type.
Starting today, 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) called "Launch" will automatically be created for your app. This can be customized or deleted like other commands if you want to update the name or handler type.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ New resources are available in the Developer Portal to help you get started with
- [Getting Started Guides](/docs/discord-social-sdk/getting-started) for C++, Unity and Unreal Engine.
- [Development Guides](/docs/discord-social-sdk/development-guides) for building your game's social features.
- [Design Guidelines](/docs/discord-social-sdk/design-guidelines) for designing your game's social features.
- [SDK Reference](http://discord.com/developers/docs/social-sdk/index.html) is now available.
- [SDK Reference](https://discord.com/developers/docs/social-sdk/index.html) is now available.
- The Discord Social SDK binaries are available for download in the Developer Portal after enabling the Discord Social SDK for your application.

To learn more about building with the Discord Social SDK, check out the [Discord Social SDK Overview](/docs/discord-social-sdk/overview).
4 changes: 2 additions & 2 deletions docs/change-log/2025-04-11-incentivized-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Custom Incentivized Links are used to customize how your incentivized link embed
- shareLink will now let you attach custom params to links you share about your game using `custom_id`.
- Removed `referrer_id` from shareLink API. Any uses of `referrer_id` should be moved over to use `custom_id` instead. Passing `referrer_id` to shareLink will silently fail.

Learn more about [creating and managing Custom Incentivized Links](https://discord.com/developers/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](https://discord.com/developers/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API.
Learn more about [creating and managing Custom Incentivized Links](/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API.

The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](https://discord.com/developers/docs/developer-tools/embedded-app-sdk) to get started with it!
The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](/docs/developer-tools/embedded-app-sdk) to get started with it!
2 changes: 1 addition & 1 deletion docs/developer-tools/community-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Discord does not maintain official SDKs. The following table is an inexhaustive

## Interactions

[Interactions](/docs/interactions/receiving-and-responding#) are the great, new way of making a Discord bot. The following open-source libraries provide help for the security and authentication checks that are mandatory if you are receiving Interactions via outgoing webhook. They also include some types for the Interactions data models.
[Interactions](/docs/interactions/receiving-and-responding) are the great, new way of making a Discord bot. The following open-source libraries provide help for the security and authentication checks that are mandatory if you are receiving Interactions via outgoing webhook. They also include some types for the Interactions data models.

- C#
- [Discord.Net.Rest](https://github.com/discord-net/Discord.Net)
Expand Down
Loading