Skip to content

fix: wording & missing info for interaction related docs #7836

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.

Sign up for GitHub

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 8 commits into from
Sep 11, 2025
Merged

fix: wording & missing info for interaction related docs #7836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5ade504
fix: name type correctly
Lulalaby Sep 11, 2025
7058b73
fix: partial channel has more fields
Lulalaby Sep 11, 2025
a658b7f
fix: statement of line wasn't true
Lulalaby Sep 11, 2025
0cdba10
fix: wording
Lulalaby Sep 11, 2025
c7590a2
fix: wording
Lulalaby Sep 11, 2025
999bdfc
fix: we should link that as well :)
Lulalaby Sep 11, 2025
cfac97f
fix: formatting / word splitting
Lulalaby Sep 11, 2025
22a33c5
fix: wording, again
Lulalaby Sep 11, 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
46 changes: 23 additions & 23 deletions docs/components/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,9 +432,9 @@ String Selects are available in messages and modals. They must be placed inside
```
</Collapsible>

<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a StringSelect" icon="code">
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a String Select" icon="code">

When a user submits a modal that contains a StringSelect, this is the basic form of the interaction data payload you will receive. The full payload
When a user submits a modal that contains a String Select, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -646,9 +646,9 @@ User Selects are available in messages and modals. They must be placed inside an
```
</Collapsible>

<Collapsible title="Message Interaction Data Example" description="When a user interacts with a UserSelect in a message" icon="code">
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a User Select in a message" icon="code">

When a user interacts with a UserSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
When a user interacts with a User Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

:::info
Expand Down Expand Up @@ -681,7 +681,7 @@ User Selects are available in messages and modals. They must be placed inside an
"permissions": "2248473465835073",
"premium_since": null,
"roles": [
"2222222222222222222"
"2222222222222222222"
],
"unusual_dm_activity_until": null
}
Expand Down Expand Up @@ -737,9 +737,9 @@ User Selects are available in messages and modals. They must be placed inside an
```
</Collapsible>

<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a UserSelect" icon="code">
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a User Select" icon="code">

When a user submits a modal that contains a UserSelect, this is the basic form of the interaction data payload you will receive. The full payload
When a user submits a modal that contains a User Select, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -886,9 +886,9 @@ Role Selects are available in messages and modals. They must be placed inside an
```
</Collapsible>

<Collapsible title="Message Interaction Data Example" description="When a user interacts with a RoleSelect in a message" icon="code">
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a Role Select in a message" icon="code">

When a user interacts with a RoleSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
When a user interacts with a Role Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -960,9 +960,9 @@ Role Selects are available in messages and modals. They must be placed inside an
```
</Collapsible>

<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a RoleSelect" icon="code">
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a Role Select" icon="code">

When a user submits a modal that contains a RoleSelect, this is the basic form of the interaction data payload you will receive. The full payload
When a user submits a modal that contains a Role Select, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -1101,9 +1101,9 @@ Mentionable Selects are available in messages and modals. They must be placed in
```
</Collapsible>

<Collapsible title="Message Interaction Data Example" description="When a user interacts with a MentionableSelect in a message" icon="code">
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a Mentionable Select in a message" icon="code">

When a user interacts with a MentionableSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
When a user interacts with a Mentionable Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

:::info
Expand Down Expand Up @@ -1137,7 +1137,7 @@ Mentionable Selects are available in messages and modals. They must be placed in
"permissions": "2248473465835073",
"premium_since": null,
"roles": [
"2222222222222222222"
"2222222222222222222"
],
"unusual_dm_activity_until": null
}
Expand Down Expand Up @@ -1213,9 +1213,9 @@ Mentionable Selects are available in messages and modals. They must be placed in
```
</Collapsible>

<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a MentionableSelect" icon="code">
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a Mentionable Select" icon="code">

When a user submits a modal that contains a MentionableSelect, this is the basic form of the interaction data payload you will receive. The full payload
When a user submits a modal that contains a Mentionable Select, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -1336,9 +1336,9 @@ Channel Selects are available in messages and modals. They must be placed inside
```
</Collapsible>

<Collapsible title="Message Interaction Data Example" description="When a user interacts with a ChannelSelect in a message" icon="code">
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a Channel Select in a message" icon="code">

When a user interacts with a ChannelSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
When a user interacts with a Channel Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -1404,9 +1404,9 @@ Channel Selects are available in messages and modals. They must be placed inside
```
</Collapsible>

<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a ChannelSelect" icon="code">
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a Channel Select" icon="code">

When a user submits a modal that contains a ChannelSelect, this is the basic form of the interaction data payload you will receive. The full payload
When a user submits a modal that contains a Channel Select, this is the basic form of the interaction data payload you will receive. The full payload
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.

```json
Expand Down Expand Up @@ -1562,7 +1562,7 @@ To use this component in messages you must send the [message flag](/docs/resourc

###### Examples

<Collapsible title="Message Example" description="Message create payload with a TextDisplay component" icon="code">
<Collapsible title="Message Example" description="Message create payload with a Text Display component" icon="code">

<Collapsible title="Rendered Example" description="Visualization of the message created by the payload below" icon="image" nested={true}>
![Example of a Text Display with markdown](images/components/text-display.webp)
Expand Down Expand Up @@ -1975,7 +1975,7 @@ To use this component in messages you must send the [message flag](/docs/resourc
A Label is a top-level layout component. Labels wrap modal components with text as a label and optional description.

:::info
The `description` may display above or below the `component` depending on platform.
The `description` may display above or below the `component` depending on the platform.
:::

###### Label Structure
Expand Down Expand Up @@ -2005,7 +2005,7 @@ The `description` may display above or below the `component` depending on platfo
|-----------|----------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
| type | integer | `18` for a Label |
| id | integer | Unique identifier for the component |
| component | [interaction response label child component](/docs/components/reference#label-label-interaction-response-child-components) | The component within the label |
| component | [label interaction response child component](/docs/components/reference#label-label-interaction-response-child-components) | The component within the label |

###### Label Interaction Response Child Components

Expand Down
12 changes: 6 additions & 6 deletions docs/interactions/receiving-and-responding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ If data for a Member is included, data for its corresponding User will also be i

\* Partial `Member` objects are missing `user`, `deaf` and `mute` fields

\*\* Partial `Channel` objects only have `id`, `name`, `type` and `permissions` fields. Threads will also have `thread_metadata` and `parent_id` fields.
\*\* Partial `Channel` objects only have `id`, `name`, `type`, `permissions`, `last_message_id`, `last_pin_timestamp`, `nsfw`, `parent_id`, `guild_id`, `flags`, `rate_limit_per_user`, `topic` and `position` fields. Threads will also have the `thread_metadata` field.

###### Application Command Interaction Data Option Structure

Expand Down Expand Up @@ -277,7 +277,7 @@ Not all message fields are currently supported.
| attachments? \*\* | array of partial [attachment](/docs/resources/message#attachment-object) objects | Attachment objects with filename and description |
| poll? | [poll](/docs/resources/poll#poll-create-request-object) request object | Details about the poll |

\* If you create a callback with the [type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type) `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE` the only valid [message flag](/docs/resources/message#message-object-message-flags) you may use is `EPHEMERAL`. If you'd like to create a component based message with `IS_COMPONENTS_V2` you must do that with the [followup](/docs/interactions/receiving-and-responding#followup-messages) message, not this one.
\* If you create a callback with the [type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type) `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE` the only valid [message flag](/docs/resources/message#message-object-message-flags) you may use is `EPHEMERAL`. If you'd like to create a component based message with `IS_COMPONENTS_V2` you must do that with the [edit original response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) endpoint, not this one.

\*\* See [Uploading Files](/docs/reference#uploading-files) for details.

Expand Down Expand Up @@ -364,8 +364,8 @@ Interaction `tokens` are valid for **15 minutes** and can be used to send follow
| type | integer | [Interaction type](/docs/interactions/receiving-and-responding#interaction-object-interaction-type) |
| activity_instance_id? | string | Instance ID of the Activity if one was launched or joined |
| response_message_id? | snowflake | ID of the message that was created by the interaction |
| response_message_loading? | boolean | Whether or not the message is in a loading state |
| response_message_ephemeral? | boolean | Whether or not the response message was ephemeral |
| response_message_loading? | boolean | Whether the message is in a loading state |
| response_message_ephemeral? | boolean | Whether the response message is ephemeral |

###### Interaction Callback Resource Object

Expand All @@ -388,7 +388,7 @@ Interaction `tokens` are valid for **15 minutes** and can be used to send follow

## Followup Messages

Sometimes, your bot will want to send followup messages to a user after responding to an interaction. Or, you may want to edit your original response. Whether you receive Interactions over the gateway or by outgoing webhook, you can use the following endpoints to edit your initial response or send followup messages:
Sometimes, you want to send followup messages to a user after responding to an interaction. Or, you may want to edit your original response. Whether you receive Interactions over the gateway or by outgoing webhook, you can use the following endpoints to edit your initial response or send followup messages:

- [`PATCH /webhooks/<application_id>/<interaction_token>/messages/@original`](/docs/interactions/receiving-and-responding#edit-original-interaction-response) to edit your initial response to an Interaction
- [`DELETE /webhooks/<application_id>/<interaction_token>/messages/@original`](/docs/interactions/receiving-and-responding#delete-original-interaction-response) to delete your initial response to an Interaction
Expand Down Expand Up @@ -445,7 +445,7 @@ Apps are limited to 5 followup messages per interaction if it was initiated from

Create a followup message for an Interaction. Functions the same as [Execute Webhook](/docs/resources/webhook#execute-webhook), but `wait` is always true. The `thread_id`, `avatar_url`, and `username` parameters are not supported when using this endpoint for interaction followups. You can use the `EPHEMERAL` [message flag](/docs/resources/message#message-object-message-flags) `1 << 6` (64) to send a message that only the user can see. You can also use the `IS_COMPONENTS_V2` [message flag](/docs/resources/message#message-object-message-flags) `1 << 15` (32768) to send a [component](/docs/components/reference)-based message.

When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the Edit Original Interaction Response endpoint in this case instead.
When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) endpoint in this case instead.

## Get Followup Message
<Route method="GET">/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object)</Route>
Expand Down