Skip to content

Commit 6030e33

Browse files
authored
Document with_components webhook param (#7368)
1 parent 1f0148b commit 6030e33

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/resources/Webhook.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -194,10 +194,11 @@ Refer to [Uploading Files](#DOCS_REFERENCE/uploading-files) for details on attac
194194
195195
###### Query String Params
196196

197-
| Field | Type | Description | Required |
198-
|-----------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
199-
| wait | [boolean](#DOCS_REFERENCE/boolean-query-strings) | waits for server confirmation of message send before response, and returns the created message body (defaults to `false`; when `false` a message that is not saved does not return an error) | false |
200-
| thread_id | snowflake | Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived. | false |
197+
| Field | Type | Description | Required |
198+
|-----------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
199+
| wait | [boolean](#DOCS_REFERENCE/boolean-query-strings) | waits for server confirmation of message send before response, and returns the created message body (defaults to `false`; when `false` a message that is not saved does not return an error) | false |
200+
| thread_id | snowflake | Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived. | false |
201+
| with_components | [boolean](#DOCS_REFERENCE/boolean-query-strings) | whether to allow sending (non-interactive) components for non-application-owned webhooks (defaults to `false`; ignored for application-owned webhooks) | false |
201202

202203
###### JSON/Form Params
203204

@@ -218,8 +219,7 @@ Refer to [Uploading Files](#DOCS_REFERENCE/uploading-files) for details on attac
218219
| applied_tags | array of snowflakes | array of tag ids to apply to the thread (requires the webhook channel to be a forum or media channel) | false |
219220
| poll | [poll](#DOCS_RESOURCES_POLL/poll-create-request-object) request object | A poll! | one of content, file, embeds, poll |
220221

221-
222-
\* Requires an application-owned webhook.
222+
\* Application-owned webhooks can always send components. Non-application-owned webhooks cannot send interactive components, and the field will be ignored unless they set the `with_components` query param.
223223

224224
\*\* See [Uploading Files](#DOCS_REFERENCE/uploading-files) for details.
225225

@@ -275,9 +275,10 @@ Any provided files will be **appended** to the message. To remove or replace fil
275275
276276
###### Query String Params
277277

278-
| Field | Type | Description | Required |
279-
|-----------|-----------|------------------------------------|----------|
280-
| thread_id | snowflake | id of the thread the message is in | false |
278+
| Field | Type | Description | Required |
279+
|-----------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
280+
| thread_id | snowflake | id of the thread the message is in | false |
281+
| with_components | [boolean](#DOCS_REFERENCE/boolean-query-strings) | whether to allow sending (non-interactive) components for non-application-owned webhooks (defaults to `false`; ignored for application-owned webhooks) | false |
281282

282283
###### JSON/Form Params
283284

@@ -292,7 +293,7 @@ Any provided files will be **appended** to the message. To remove or replace fil
292293
| attachments \*\* | array of partial [attachment](#DOCS_RESOURCES_MESSAGE/attachment-object) objects | attached files to keep and possible descriptions for new files |
293294
| poll \*\*\* | [poll](#DOCS_RESOURCES_POLL/poll-create-request-object) request object | A poll! |
294295

295-
\* Requires an application-owned webhook.
296+
\* Application-owned webhooks can always send components. Non-application-owned webhooks cannot send interactive components, and the field will be ignored unless they set the `with_components` query param.
296297

297298
\*\* See [Uploading Files](#DOCS_REFERENCE/uploading-files) for details.
298299

0 commit comments

Comments
 (0)