diff --git a/docs/resources/application.mdx b/docs/resources/application.mdx index b6f4425c07..4183331011 100644 --- a/docs/resources/application.mdx +++ b/docs/resources/application.mdx @@ -10,39 +10,40 @@ sidebar_label: Application ###### Application Structure -| Field | Type | Description | -|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| id | snowflake | ID of the app | -| name | string | Name of the app | -| icon | ?string | [Icon hash](/docs/reference#image-formatting) of the app | -| description | string | Description of the app | -| rpc_origins? | array of strings | List of RPC origin URLs, if RPC is enabled | -| bot_public | boolean | When `false`, only the app owner can add the app to guilds | -| bot_require_code_grant | boolean | When `true`, the app's bot will only join upon completion of the full OAuth2 code grant flow | -| bot? | partial [user](/docs/resources/user#user-object) object | Partial user object for the bot user associated with the app | -| terms_of_service_url? | string | URL of the app's Terms of Service | -| privacy_policy_url? | string | URL of the app's Privacy Policy | -| owner? | partial [user](/docs/resources/user#user-object) object | Partial user object for the owner of the app | -| verify_key | string | Hex encoded key for verification in interactions and the GameSDK's [GetTicket](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Applications.md#getticket) | -| team | ?[team](/docs/topics/teams#data-models-team-object) object | If the app belongs to a team, this will be a list of the members of that team | -| guild_id? | snowflake | Guild associated with the app. For example, a developer support server. | -| guild? | partial [guild](/docs/resources/guild#guild-object) object | Partial object of the associated guild | -| primary_sku_id? | snowflake | If this app 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 app is a game sold on Discord, this field will be the URL slug that links to the store page | -| cover_image? | string | App's default rich presence invite [cover image hash](/docs/reference#image-formatting) | -| flags? | integer | App's public [flags](/docs/resources/application#application-object-application-flags) | -| approximate_guild_count? | integer | Approximate count of guilds the app has been added to | -| approximate_user_install_count? | integer | Approximate count of users that have installed the app | -| redirect_uris? | array of strings | Array of redirect URIs for the app | -| interactions_endpoint_url? | ?string | [Interactions endpoint URL](/docs/interactions/receiving-and-responding#receiving-an-interaction) for the app | -| role_connections_verification_url? | ?string | Role connection verification URL for the app | -| event_webhooks_url? | ?string | [Event webhooks URL](/docs/events/webhook-events#preparing-for-events) for the app to receive webhook events | -| event_webhooks_status | [application event webhook status](/docs/resources/application#application-object-application-event-webhook-status) | If [webhook events](/docs/events/webhook-events) are enabled for the app. `1` (default) means disabled, `2` means enabled, and `3` means disabled by Discord | -| event_webhooks_types? | array of strings | List of [Webhook event types](/docs/events/webhook-events#event-types) the app subscribes to | -| tags? | array of strings | List of tags describing the content and functionality of the app. Max of 5 tags. | -| install_params? | [install params](/docs/resources/application#install-params-object) object | Settings for the app's default in-app authorization link, if enabled | -| integration_types_config? | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | Default scopes and permissions for each supported installation context. Value for each key is an [integration type configuration object](/docs/resources/application#application-object-application-integration-type-configuration-object) | -| custom_install_url? | string | Default custom authorization URL for the app, if enabled | +| Field | Type | Description | +|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | snowflake | ID of the app | +| name | string | Name of the app | +| icon | ?string | [Icon hash](/docs/reference#image-formatting) of the app | +| description | string | Description of the app | +| rpc_origins? | array of strings | List of RPC origin URLs, if RPC is enabled | +| bot_public | boolean | When `false`, only the app owner can add the app to guilds | +| bot_require_code_grant | boolean | When `true`, the app's bot will only join upon completion of the full OAuth2 code grant flow | +| bot? | partial [user](/docs/resources/user#user-object) object | Partial user object for the bot user associated with the app | +| terms_of_service_url? | string | URL of the app's Terms of Service | +| privacy_policy_url? | string | URL of the app's Privacy Policy | +| owner? | partial [user](/docs/resources/user#user-object) object | Partial user object for the owner of the app | +| verify_key | string | Hex encoded key for verification in interactions and the GameSDK's [GetTicket](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Applications.md#getticket) | +| team | ?[team](/docs/topics/teams#data-models-team-object) object | If the app belongs to a team, this will be a list of the members of that team | +| guild_id? | snowflake | Guild associated with the app. For example, a developer support server. | +| guild? | partial [guild](/docs/resources/guild#guild-object) object | Partial object of the associated guild | +| primary_sku_id? | snowflake | If this app 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 app is a game sold on Discord, this field will be the URL slug that links to the store page | +| cover_image? | string | App's default rich presence invite [cover image hash](/docs/reference#image-formatting) | +| flags? | integer | App's public [flags](/docs/resources/application#application-object-application-flags) | +| approximate_guild_count? | integer | Approximate count of guilds the app has been added to | +| approximate_user_install_count? | integer | Approximate count of users that have installed the app (authorized with `application.commands` as a scope) | +| approximate_user_authorization_count? | integer | Approximate count of users that have OAuth2 authorizations for the app | +| redirect_uris? | array of strings | Array of redirect URIs for the app | +| interactions_endpoint_url? | ?string | [Interactions endpoint URL](/docs/interactions/receiving-and-responding#receiving-an-interaction) for the app | +| role_connections_verification_url? | ?string | Role connection verification URL for the app | +| event_webhooks_url? | ?string | [Event webhooks URL](/docs/events/webhook-events#preparing-for-events) for the app to receive webhook events | +| event_webhooks_status | [application event webhook status](/docs/resources/application#application-object-application-event-webhook-status) | If [webhook events](/docs/events/webhook-events) are enabled for the app. `1` (default) means disabled, `2` means enabled, and `3` means disabled by Discord | +| event_webhooks_types? | array of strings | List of [Webhook event types](/docs/events/webhook-events#event-types) the app subscribes to | +| tags? | array of strings | List of tags describing the content and functionality of the app. Max of 5 tags. | +| install_params? | [install params](/docs/resources/application#install-params-object) object | Settings for the app's default in-app authorization link, if enabled | +| integration_types_config? | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | Default scopes and permissions for each supported installation context. Value for each key is an [integration type configuration object](/docs/resources/application#application-object-application-integration-type-configuration-object) | +| custom_install_url? | string | Default custom authorization URL for the app, if enabled | ###### Example Application Object