Slash Commands and Interactions #2295

msciotti · 2020-12-09T20:43:36Z

Opening the PR now because the "meat" of the docs are done. Just a quick note:

Comments on this PR should be solely about the documentation. When this launches, we will have specific repo templates for feedback on the feature itself. I will pretty aggressively prune the convo here to be documentation-only so that we can get this out

This documentation page is a bit of a monolith, and should probably be split up into smaller sections. The same can be said of most of our documentation, to be honest. I'm prioritizing having the documentation ready over having it look pretty, and we can revisit later.

TODO:

Write a better intro
Document INTERACTION_CREATE gateway event
Document subcommands and groups
How does the security check actually work
Make sure all the links work
Put a resources section since we have a nice node and python library to help with cryptography and some data models
Check styling in local dev for 🌟 aesthetics 🌟
Make sure the code examples actually work
Document limits

docs/interactions/Slash_Commands.md

docs/Change_Log.md

Co-authored-by: Advaith <advaithj1@gmail.com>

msciotti · 2020-12-15T01:02:21Z

This is my final draft now. All the information should be correct, even if some could be better. I'll be merging and deploying this tonight so after that any changes can be PR'd against master.

docs/interactions/Slash_Commands.md

A5rocks · 2020-12-15T02:22:36Z

docs/interactions/Slash_Commands.md

+
+Fetch all of the global commands for your application. Returns an array of [ApplicationCommand](#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommand) objects.
+
+## Create Global Application Command % POST /applications/{application.id#DOCS_TOPICS_OAUTH2/application-object}/commands


Is there a limit to the payload size for this endpoint? (Hopefully it's large enough, the previous permission example was 1kb minified 😰)

A limit to the payload size for creating commands?

Like how there's limits to embeds and whatnot, I guess. I was mostly just asking for the sake of asking, though.

Those limits are mostly just because our send_message has a max filesize on it I believe

Snazzah

Docs are missing out on talking about message flags or using the EPHEMERAL flag.

docs/interactions/Slash_Commands.md

Snazzah · 2020-12-15T02:47:46Z

docs/interactions/Slash_Commands.md

+| tts?              | bool             | is the response TTS                                                                         |
+| content           | string           | message content                                                                             |
+| embeds?           | array of embeds  | supports up to 10 embeds                                                                    |
+| allowed_mentions? | allowed mentions | [allowed mentions](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object) object                  |


From what i've seen, flags would be here too.

I've intentionally left flags off for now because ephemeral messages aren't quite done (UI-wise) on all platforms.

Snazzah · 2020-12-15T02:52:35Z

docs/interactions/Slash_Commands.md

+
+## Edit Followup Message % PATCH /webhooks/application.id/{interaction.token#DOCS_INTERACTIONS_SLASH_COMMANDS/interaction}/messages/{message.id#DOCS_RESOURCES_CHANNEL/message-object}
+
+Edits a followup message for an Interaction. Functions the same as [Edit Webhook Message](#DOCS_RESOURCES_WEBHOOK/edit-webhook-message).


Does this do the same behavior as setting wait to true in executing commands?

(meant to put this in creating a follow-up message)

Not entirely sure what you mean. Do you mean will it return the message object when creating a followup message?

Yeah, that was my question. Meant to say executing webhooks not commands.

A5rocks · 2020-12-15T03:39:27Z

docs/interactions/Slash_Commands.md

+| data?\*    | ApplicationCommandInteractionData | the command data payload                                |
+| guild_id   | snowflake                         | the guild it was sent from                              |
+| channel_id | snowflake                         | the channel it was sent from                            |
+| member     | GuildMember                       | guild member data for the invoking user                 |


Is this guaranteed to have the User attached, unlike CREATE_MESSAGE?

Yes the user object is guaranteed

docs/interactions/Slash_Commands.md

A5rocks · 2020-12-15T03:41:17Z

docs/interactions/Slash_Commands.md

+
+After receiving an interaction, you must respond to acknowledge it. This may be a `pong` for a `ping`, a message, or simply an acknowledgement that you have received it and will handle the command async.
+
+Interaction responses may choose to "eat" the user's command input if you do not wish to have their slash command show up as message in chat. This may be helpful for slash commands, or commands whose responses are asynchronous or ephemeral messages.


I feel "swallow" is the more widely used term here, but "eat" is a fun word.

Yknow, I knew "eat" wasn't quite it but I knew it was some sort of eating-based word. I'm keeping it now though I've become attached :p

docs/interactions/Slash_Commands.md

A5rocks · 2020-12-15T03:47:21Z

docs/topics/Community_Resources.md

@@ -39,6 +39,13 @@ Many of these libraries are represented in the [unofficial, community-driven Dis
 | [Sword](https://github.com/Azoy/Sword)                       | Swift      |
 | [Discordeno](https://github.com/Skillz4Killz/Discordeno)     | TypeScript |

+## Interactions
+
+[Interactions and Slash Commands](#DOCS_INTERACTIONS_SLASH_COMMANDS/) 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.


The comma after great feels weird.

Snazzah · 2020-12-15T09:54:04Z

docs/interactions/Slash_Commands.md

+
+## Create Followup Message % POST /webhooks/application.id/{interaction.token#DOCS_INTERACTIONS_SLASH_COMMANDS/interaction}
+
+Create a followup message for an Interaction. Functions the same as [Execute Webhook](#DOCS_RESOURCES_WEBHOOK/execute-webhook)


Can this use different interaction types (like ChannelMessageWithSource) or is it completely restricted to the parameters from webhooks? If it is restricted, will we be able to use file in interaction responses or would it only be here?

Followups are only webhook messages, types are only for the initial response

Advaith is correct that only the original response supports the different types since any followup message is just like sending a normal message.

I don't believe we support file yet, but we should. Had to make some tradeoffs in the architecture to start but definitely noted :)

Fabricio20 · 2020-12-15T11:15:24Z

docs/interactions/Slash_Commands.md

+| INTEGER           | 4     |
+| BOOLEAN           | 5     |
+| USER              | 6     |
+| CHANNEL           | 7     |


Is type 7 here any channel, only text channels or voice channels as well?

Any channel - from text channels to channel categories.

Any channel within the guild, yes. So no DM channels but everything else including categories, store channels, etc.

bsian03 · 2020-12-15T12:14:54Z

docs/topics/OAuth2.md

@@ -386,6 +387,7 @@ Returns the bot's OAuth2 application info.
 | primary_sku_id?        | snowflake                                                  | if this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists     |
 | slug?                  | string                                                     | if this application is a game sold on Discord, this field will be the URL slug that links to the store page               |
 | cover_image?           | string                                                     | if this application is a game sold on Discord, this field will be the hash of the image on store embeds                   |
+| flags                  | int                                                        | the application's public flags                                                                                            |


Is there any specific reason why this isn't called public_flags?

I think that all the flags on an application actually are public, as opposed to users where we specifically differentiate. Calling them the public flags covers my butt for now but I can confirm.

It would be useful for future-proofing for a future where bots could be boosted.

msciotti · 2020-12-15T16:47:15Z

Thanks everyone for your help in getting this PR into a good state! As always if we find more things that need clarifying or changing, PRs or pings are always welcome. There's also two new issue templates here for slash command bugs and feature requests, so we'll keep an eye on those!

WalshyDev · 2020-12-15T17:03:34Z

Mason, could you tell us what the rollout plans are for this feature? Now this is merged and we have feature/bug templates, are we going to see the rollout starting today?

Skye-31 · 2020-12-15T17:21:12Z

broken link?

See discord/discord-api-docs#2295.

msciotti added 2 commits December 9, 2020 12:31

Slash Commands and Interactions documentation

30e6cca

Nits and TODOs

ab6892a

discord locked and limited conversation to collaborators Dec 9, 2020

Erk- mentioned this pull request Dec 9, 2020

feature: support for slash commands twilight-rs/twilight#634

Closed

19 tasks

Merge branch 'master' into feature/interactions

d0479f9

vladfrangu mentioned this pull request Dec 9, 2020

chore: Slash Commands typings discordjs/discord-api-types#44

Merged

DjDeveloperr mentioned this pull request Dec 10, 2020

feat: Slash Commands & Interactions [WIP?] harmonyland/harmony#56

Merged

create, not created

3792e8b

yonilerner reviewed Dec 10, 2020

View reviewed changes

docs/interactions/Slash_Commands.md Outdated Show resolved Hide resolved

itohatweb mentioned this pull request Dec 10, 2020

Support for Slash Commands and Interactions discordeno/discordeno#247

Closed

5 tasks

Skillz4Killz mentioned this pull request Dec 10, 2020

feat: slash commands and interactions discordeno/discordeno#248

Merged

6 tasks

msciotti added 2 commits December 10, 2020 10:04

Fix python make command example

452fa08

More endpoints

0e12e9e

Darkflame72 mentioned this pull request Dec 10, 2020

Support slash commands Rapptz/discord.py#6149

Closed

groups and subcommands

f84f72b

yonilerner reviewed Dec 10, 2020

View reviewed changes

docs/interactions/Slash_Commands.md Outdated Show resolved Hide resolved

should be application id

a4e5d78

This was referenced Dec 11, 2020

Supporting Slash commands harmonyland/harmony#58

Closed

Slash Commands Support discordjs/discord.js#5103

Closed

msciotti added 5 commits December 11, 2020 13:27

interaction create event

261dfc9

Rate limits and maximums

3928824

http verbs

36108ce

Signature validation examples

0b79af3

More limits

bc58e57

night reviewed Dec 12, 2020

View reviewed changes

docs/interactions/Slash_Commands.md Outdated Show resolved Hide resolved

night reviewed Dec 12, 2020

View reviewed changes

docs/interactions/Slash_Commands.md Outdated Show resolved Hide resolved

erkinalp mentioned this pull request Dec 14, 2020

Use application commands galacticwarrior9/IslamBot#9

Closed

Neuheit mentioned this pull request Dec 14, 2020

INTEGRATION_UPDATE event not handled DSharpPlus/DSharpPlus#709

Closed

discord unlocked this conversation Dec 14, 2020

a better intro

957c592

advaith1 reviewed Dec 15, 2020

View reviewed changes

docs/Change_Log.md Outdated Show resolved Hide resolved

msciotti and others added 3 commits December 14, 2020 16:44

Broken links and spelling

b50621f

Co-authored-by: Advaith <advaithj1@gmail.com>

fix old merge issue in webhook edit

4a82475

subcommand warning

11b21c6

msciotti changed the title ~~[WIP] Slash Commands and Interactions~~ Slash Commands and Interactions Dec 15, 2020

A5rocks reviewed Dec 15, 2020

View reviewed changes

Snazzah suggested changes Dec 15, 2020

View reviewed changes

Snazzah reviewed Dec 15, 2020

View reviewed changes

msciotti added 2 commits December 14, 2020 19:28

PR feedback

5b969d3

add s

c39f703

A5rocks reviewed Dec 15, 2020

View reviewed changes

Snazzah reviewed Dec 15, 2020

View reviewed changes

Fabricio20 reviewed Dec 15, 2020

View reviewed changes

bsian03 reviewed Dec 15, 2020

View reviewed changes

A5rocks mentioned this pull request Dec 15, 2020

Embeds do not show when using webhooks with ephemeral messages #2309

Closed

spelling

9adc416

msciotti merged commit aa200b5 into master Dec 15, 2020

msciotti deleted the feature/interactions branch December 15, 2020 16:47

Nihlus added a commit to Remora/Remora.Discord that referenced this pull request Dec 17, 2020

Implement slash command objects.

8615b2b

See discord/discord-api-docs#2295.

Nihlus added a commit to Remora/Remora.Discord that referenced this pull request Dec 17, 2020

Implement interfaces of new REST API endpoints.

e5efcad

See discord/discord-api-docs#2295.

Nihlus added a commit to Remora/Remora.Discord that referenced this pull request Dec 18, 2020

Implement new REST API endpoints.

508ace9

See discord/discord-api-docs#2295.

UnderMybrella mentioned this pull request Dec 20, 2020

Add slash commands to discord4j-rest and discord4j-gateway Discord4J/Discord4J#823

Merged

vaporoxx mentioned this pull request Dec 23, 2020

feat(Application): application flags discordjs/discord.js#5147

Merged

5 tasks

angelobreuer mentioned this pull request Dec 29, 2020

Documentation for application.flags is missing #2435

Closed

Erk- mentioned this pull request Jan 11, 2021

feature: support for slash commands twilight-rs/twilight#684

Closed

20 tasks

A5rocks mentioned this pull request Feb 16, 2021

Not blocking acknowledge response type #2613

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Slash Commands and Interactions #2295

Slash Commands and Interactions #2295

msciotti commented Dec 9, 2020 •

edited

Loading

msciotti commented Dec 15, 2020

A5rocks Dec 15, 2020

msciotti Dec 15, 2020

A5rocks Dec 15, 2020

msciotti Dec 15, 2020

Snazzah left a comment

Snazzah Dec 15, 2020 •

edited

Loading

msciotti Dec 15, 2020

Snazzah Dec 15, 2020 •

edited

Loading

msciotti Dec 15, 2020

Snazzah Dec 15, 2020

A5rocks Dec 15, 2020 •

edited

Loading

msciotti Dec 15, 2020

A5rocks Dec 15, 2020

msciotti Dec 15, 2020

A5rocks Dec 15, 2020

Snazzah Dec 15, 2020

advaith1 Dec 15, 2020

msciotti Dec 15, 2020

Fabricio20 Dec 15, 2020

ThaTiemsz Dec 15, 2020

msciotti Dec 15, 2020

bsian03 Dec 15, 2020

msciotti Dec 15, 2020

erkinalp Dec 16, 2020

msciotti commented Dec 15, 2020

WalshyDev commented Dec 15, 2020

Skye-31 commented Dec 15, 2020


		Fetch all of the global commands for your application. Returns an array of [ApplicationCommand](#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommand) objects.

		## Create Global Application Command % POST /applications/{application.id#DOCS_TOPICS_OAUTH2/application-object}/commands


		## Edit Followup Message % PATCH /webhooks/application.id/{interaction.token#DOCS_INTERACTIONS_SLASH_COMMANDS/interaction}/messages/{message.id#DOCS_RESOURCES_CHANNEL/message-object}

		Edits a followup message for an Interaction. Functions the same as [Edit Webhook Message](#DOCS_RESOURCES_WEBHOOK/edit-webhook-message).


		After receiving an interaction, you must respond to acknowledge it. This may be a `pong` for a `ping`, a message, or simply an acknowledgement that you have received it and will handle the command async.

		Interaction responses may choose to "eat" the user's command input if you do not wish to have their slash command show up as message in chat. This may be helpful for slash commands, or commands whose responses are asynchronous or ephemeral messages.


		## Create Followup Message % POST /webhooks/application.id/{interaction.token#DOCS_INTERACTIONS_SLASH_COMMANDS/interaction}

		Create a followup message for an Interaction. Functions the same as [Execute Webhook](#DOCS_RESOURCES_WEBHOOK/execute-webhook)

Slash Commands and Interactions #2295

Slash Commands and Interactions #2295

Conversation

msciotti commented Dec 9, 2020 • edited Loading

msciotti commented Dec 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Snazzah left a comment

Choose a reason for hiding this comment

Snazzah Dec 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Snazzah Dec 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

A5rocks Dec 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msciotti commented Dec 15, 2020

WalshyDev commented Dec 15, 2020

Skye-31 commented Dec 15, 2020

msciotti commented Dec 9, 2020 •

edited

Loading

Snazzah Dec 15, 2020 •

edited

Loading

Snazzah Dec 15, 2020 •

edited

Loading

A5rocks Dec 15, 2020 •

edited

Loading