[onboarding] Adds initial docs for Onboarding API #5915

hammerdr · 2023-02-09T17:17:48Z

No description provided.

docs/resources/Guild.md

Victorsitou · 2023-02-09T20:28:52Z

Will audit log stuff be documented in this PR?

Victorsitou · 2023-02-09T21:52:18Z

docs/resources/Guild.md

@@ -1166,6 +1266,10 @@ Modify the guild's [Welcome Screen](#DOCS_RESOURCES_GUILD/welcome-screen-object)
 | welcome_channels | array of [welcome screen channel](#DOCS_RESOURCES_GUILD/welcome-screen-object-welcome-screen-channel-structure) objects | channels linked in the welcome screen and their display options |
 | description      | string                                                                                                                  | the server description to show in the welcome screen            |

+## Get Guild Onboarding % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/onboarding
+
+Returns the [Onboarding](#DOCS_RESOURCES_GUILD/guild-onboarding-object) object for the guild.


Does this need any permission?

Does this need any permission?

I doubt it because the client needs to use it when it first joins a server.

docs/resources/Guild.md

advaith1 · 2023-02-10T08:26:28Z

looks like this endpoint returns a 404 unless x-super-properties is set
is there a reason bots cannot edit the onboarding config?
is there a reason /guilds/:id/top-read-channels isn't documented here?

hammerdr · 2023-02-10T17:27:17Z

looks like this endpoint returns a 404 unless x-super-properties is set

Can you elaborate? I just need an Authorization header when testing via curl

Your other questions just aren't covered by this particular PR.

advaith1 · 2023-02-10T20:54:03Z

The endpoint has a client version number check (probably as part of the experiment gating) so when I fetch it in Postman (using a bot token), it returns

{
    "message": "404: Not Found",
    "code": 0
}

unless I include an X-Super-Properties header copied from the client. that seems to still count toward the strict twice-per-minute rate limit though

hammerdr · 2023-02-10T21:46:30Z

I see. I guess my test server is enabled differently and doesn't have this issue.

Okay, as far as this API goes, we're going to do a revision to get Emoji to match the shared definition. But it will take some time for that to release. We'll leave this API PR up as reference for the time being, but please consider it pre-alpha and subject to change at any point.

wasdennnoch · 2023-02-21T19:03:09Z

docs/resources/Guild.md

+| id          | snowflake                                          | the id of the option                                 |
+| channel_ids | array of snowflakes                                | the channels opted into when this option is selected |
+| role_ids    | array of snowflakes                                | the roles assigned when this option is selected      |
+| emoji       | [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | the emoji of the option                              |


suneettipirneni · 2023-02-23T16:45:01Z

docs/resources/Guild.md

+| id          | snowflake                                          | the id of the option                                 |
+| channel_ids | array of snowflakes                                | the channels opted into when this option is selected |
+| role_ids    | array of snowflakes                                | the roles assigned when this option is selected      |
+| emoji       | [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | the emoji of the option                              |


The docs for the emoji structure state that the name can only be null for reactions. However, when there is no emoji set for a prompt option the emoji is { "id": null, "name": null, "animated": false }. Should the docs be updated for the emoji structure to reflect this?

Ideally it should be emoji: null then instead of a structure filled with nulls; I think that's how it works in other parts of the API too.

shaydewael · 2023-03-31T20:13:22Z

docs/resources/Guild.md

+
+

Suggested change

Represents the [onboarding](https://support.discord.com/hc/en-us/articles/11074987197975-Community-Onboarding-FAQ) flow for a guild.

shaydewael · 2023-03-31T20:16:14Z

docs/resources/Guild.md

+
+
+
+###### Prompt Type


Suggested change

###### Prompt Type

###### Prompt Types

shaydewael · 2023-03-31T20:21:45Z

docs/resources/Guild.md

+| Value | Name            |
+| ----- | --------------- |
+| 0     | Multiple Choice |
+| 1     | Dropdown        |


to standardize it with most of the other type tables in docs

Suggested change

| Value | Name |

| ----- | --------------- |

| 0 | Multiple Choice |

| 1 | Dropdown |

| Name | Value |

| --------------- | ----- |

| MULTIPLE_CHOICE | 0 |

| DROPDOWN | 1 |

shaydewael · 2023-03-31T20:23:30Z

docs/resources/Guild.md

+| options       | array of [prompt option](#DOCS_RESOURCES_GUILD/guild-onboarding-object-prompt-option-structure) objects | Options available within the prompt                                        |
+| title         | string                                                                                                  | Title of the prompt                                                        |
+| single_select | boolean                                                                                                 | Indicates whether users are limited to selecting one option for the prompt |
+| required      | boolean                                                                                                 | Indicates whether the prompt is required in the onboarding flow             |


shaydewael · 2023-03-31T20:24:54Z

docs/resources/Guild.md

+
+| Field       | Type                                               | Description                                                       |
+| ----------- | -------------------------------------------------- | ----------------------------------------------------------------- |
+| id          | snowflake                                          | ID of the option                                                  |


shaydewael · 2023-03-31T20:26:04Z

docs/resources/Guild.md

+
+
+


Suggested change

shaydewael · 2023-03-31T20:26:34Z

docs/resources/Guild.md

+}
+```
+
+


Suggested change

shaydewael · 2023-03-31T20:26:47Z

docs/resources/Guild.md

+| required      | boolean                                                                                                 | Indicates whether the prompt is required in the onboarding flow             |
+| in_onboarding | boolean                                                                                                 | Indicates whether the prompt is in the onboarding flow                     |
+
+


Suggested change

shaydewael · 2023-03-31T20:26:54Z

docs/resources/Guild.md

+| default_channel_ids | array of snowflakes                                                                                             | Channel IDs that  members get opted into automatically     |
+| enabled             | boolean                                                                                                         | Whether onboarding is enabled in the guild                 |
+
+


Suggested change

Puncher1 · 2023-03-31T20:46:41Z

A few fields are missing, which I get:

"enable_default_channels": true,
"enable_onboarding_prompts": true,
"onboarding_prompts_seen": {},
"onboarding_responses_seen": {},
"responses": []

This would belong to the Onboarding Structure

docs/resources/Guild.md

Co-authored-by: Florian Spieß <business@minnced.club>

onerandomusername · 2023-04-01T02:21:24Z

So... any plans to document the audit log aspect of onboarding?

discord/discord-api-docs#5915

To get the GuildOnboarding object for a Guild just call guild.getOnboarding(). see discord/discord-api-docs#5915 --------- Co-authored-by: Lukellmann <lukellmann@gmail.com>

Implements guild onboarding ref: discord/discord-api-docs#5915 This adds the following structures: Onboarding OnboardingPrompt OnboardingPromptOption OnboardingPromptType As well as supporting the http GET for retrieving guild onboarding information. Closes #2134

-> discord/discord-api-docs#5915 Signed-off-by: mccoderpy <mccuber04@outlook.de>

Co-authored-by: Shay <shay.dewael@discordapp.com> Co-authored-by: Florian Spieß <business@minnced.club>

[onboarding] Adds initial docs for Onboarding API

6d3b804

hammerdr requested a review from shaydewael February 9, 2023 17:18

mccoderpy mentioned this pull request Feb 9, 2023

[Feature Request]: Implement Community Onboarding mccoderpy/discord.py-message-components#64

Open

wasdennnoch reviewed Feb 9, 2023

View reviewed changes

docs/resources/Guild.md Outdated Show resolved Hide resolved

docs/resources/Guild.md Outdated Show resolved Hide resolved

almeidx mentioned this pull request Feb 9, 2023

feat: guild onboarding discordjs/discord-api-types#713

Merged

seailz mentioned this pull request Feb 9, 2023

[Feature Request] Guild Onboarding discord-jar/discord.jar#135

Closed

3 tasks

fix emoji_name

776a2a7

almeidx mentioned this pull request Feb 9, 2023

feat: guild onboarding discordjs/discord.js#9120

Merged

Victorsitou mentioned this pull request Feb 9, 2023

feat: implement onboarding DisnakeDev/disnake#928

Merged

8 tasks

sebm253 mentioned this pull request Feb 9, 2023

add guild onboarding disgoorg/disgo#238

Merged

Victorsitou reviewed Feb 9, 2023

View reviewed changes

suneettipirneni mentioned this pull request Feb 9, 2023

feat(model, http): Add support for guild onboarding twilight-rs/twilight#2130

Merged

IllagerCaptain reviewed Feb 10, 2023

View reviewed changes

docs/resources/Guild.md Outdated Show resolved Hide resolved

suneettipirneni mentioned this pull request Feb 10, 2023

Support guild onboarding twilight-rs/twilight#2134

Closed

update emoji docs

d7d4d5b

wasdennnoch reviewed Feb 21, 2023

View reviewed changes

suneettipirneni reviewed Feb 23, 2023

View reviewed changes

Misha-133 mentioned this pull request Mar 2, 2023

[Feature] Guild Onboarding support discord-net/Discord.Net#2616

Merged

3 tasks

update description formatting

82b0efd

shaydewael approved these changes Mar 31, 2023

View reviewed changes

advaith1 reviewed Mar 31, 2023

View reviewed changes

docs/resources/Guild.md Outdated Show resolved Hide resolved

clarify

7415681

MinnDevelopment reviewed Mar 31, 2023

View reviewed changes

docs/resources/Guild.md Outdated Show resolved Hide resolved

Update docs/resources/Guild.md

44ff865

Co-authored-by: Florian Spieß <business@minnced.club>

hammerdr added 2 commits March 31, 2023 23:09

Apply feedback from shaydewael

7480f07

fix link

8e8f1bc

hammerdr merged commit e986a12 into main Mar 31, 2023

hammerdr deleted the onboarding/docs branch March 31, 2023 23:11

NoComment1105 mentioned this pull request Apr 1, 2023

Add guild onboarding kordlib/kord#805

Merged

DonovanDMC added a commit to OceanicJS/Oceanic that referenced this pull request Apr 2, 2023

onboarding

5617bda

discord/discord-api-docs#5915

seailz mentioned this pull request Apr 2, 2023

[FEATURE] Guild Onboarding Support discord-jar/discord.jar#153

Merged

4 tasks

MazeXP mentioned this pull request Apr 3, 2023

Implement onboarding Remora/Remora.Discord#293

Merged

KubaZ2 added a commit to NetCordDev/NetCord that referenced this pull request Apr 4, 2023

Add onboarding support (discord/discord-api-docs#5915)

939c720

NeloBlivion mentioned this pull request Jun 16, 2023

feat: Implement Onboarding features Pycord-Development/pycord#2127

Merged

9 tasks

mccoderpy added a commit to mccoderpy/discord.py-message-components that referenced this pull request Aug 21, 2023

feat: Add support for community onboarding

2bfec0d

-> discord/discord-api-docs#5915 Signed-off-by: mccoderpy <mccuber04@outlook.de>

shaydewael added a commit to Jupith/discord-api-docs that referenced this pull request May 14, 2024

[onboarding] Adds docs for Onboarding API (discord#5915)

14ed565

Co-authored-by: Shay <shay.dewael@discordapp.com> Co-authored-by: Florian Spieß <business@minnced.club>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[onboarding] Adds initial docs for Onboarding API #5915

[onboarding] Adds initial docs for Onboarding API #5915

hammerdr commented Feb 9, 2023

Victorsitou commented Feb 9, 2023 •

edited

Loading

Victorsitou Feb 9, 2023

seailz Feb 10, 2023

advaith1 commented Feb 10, 2023

hammerdr commented Feb 10, 2023

advaith1 commented Feb 10, 2023

hammerdr commented Feb 10, 2023

wasdennnoch Feb 21, 2023

suneettipirneni Feb 23, 2023

wasdennnoch Feb 23, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

shaydewael Mar 31, 2023

Puncher1 commented Mar 31, 2023

onerandomusername commented Apr 1, 2023

	\| emoji \| [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object \| the emoji of the option \|
	\| emoji \| partial [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object \| the emoji of the option \|



	Represents the [onboarding](https://support.discord.com/hc/en-us/articles/11074987197975-Community-Onboarding-FAQ) flow for a guild.

	\| required \| boolean \| Indicates whether the prompt is required in the onboarding flow \|
	\| required \| boolean \| Indicates whether the prompt is required in the onboarding flow \|

	\| id \| snowflake \| ID of the option \|
	\| id \| snowflake \| ID of the prompt option \|

		\| required \| boolean \| Indicates whether the prompt is required in the onboarding flow \|
		\| in_onboarding \| boolean \| Indicates whether the prompt is in the onboarding flow \|

		\| default_channel_ids \| array of snowflakes \| Channel IDs that members get opted into automatically \|
		\| enabled \| boolean \| Whether onboarding is enabled in the guild \|

		}
		```

[onboarding] Adds initial docs for Onboarding API #5915

[onboarding] Adds initial docs for Onboarding API #5915

Conversation

hammerdr commented Feb 9, 2023

Victorsitou commented Feb 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

advaith1 commented Feb 10, 2023

hammerdr commented Feb 10, 2023

advaith1 commented Feb 10, 2023

hammerdr commented Feb 10, 2023

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

Puncher1 commented Mar 31, 2023

onerandomusername commented Apr 1, 2023

Victorsitou commented Feb 9, 2023 •

edited

Loading