Integraciones
Integrations represent a connection between a service and a guild. This may include third-party services such as Twitch or YouTube, Discord-housed integrations such as bots, or internal integrations such as role subscriptions.
id 1
snowflake
The ID of the integration
name
string
The name of the integration
enabled
boolean
Whether this integration is enabled
syncing? 2
boolean
Whether this integration is syncing
role_id? 2
snowflake
Role ID that this integration uses for subscribers
enable_emoticons? 2
boolean
Whether emoticons should be synced for this integration (Twitch only)
expire_grace_period? 2
integer
The grace period before expiring subscribers (one of 1, 3, 7, 14, 30, in days)
synced_at? 2
ISO8601 timestamp
When this integration was last synced
subscriber_count? 2
integer
How many subscribers this integration has
revoked? 2
boolean
Whether this integration has been revoked
role_connections_metadata 3 4
array[application role connection metadata object]
The metadata that the application has set for role connections
1 This field may also be the literal string "twitch-partners" to represent the Twitch Partners integration.
2 Only provided for Twitch and YouTube integrations.
3 Only provided for Discord application integrations.
4 Only included when fetched from Get Guild Integrations with set to .
5 Only included for integrations when fetched through the Get Guild Integrations endpoint. Some older or internally-created integrations may not have an attached user.
twitch
Twitch integration
youtube
YouTube integration
discord
Discord application integration
guild_subscription
Internal role subscription integration
0
REMOVE_ROLE
Remove the subscriber role from the user on expiration
1
KICK
Remove the user from the guild on expiration
id
string
The ID of the account
name
string
The name of the account
Integration Application Structure
id
snowflake
The ID of the application
name
string
The name of the application
description
string
The description of the application
primary_sku_id?
snowflake
The ID of the application's primary SKU (game, application subscription, etc.)
role_connections_verification_url? 1
?string
The role connection verification entry point of the integration; when configured, this will render the application as a verification method in guild role verification configuration
is_verified
boolean
Whether the application is verified
is_discoverable
boolean
Whether the application is discoverable in the application directory
is_monetized
boolean
Whether the application has monetization enabled
1 Only present when fetched from the Get Guild Integrations endpoint with set to .
id
snowflake
The ID of the guild
name
string
The name of the guild (2-100 characters)
id
string
The ID of the GIF
title (deprecated)
string
The title of the GIF
url
string
The provider source URL of the GIF
src
string
The media URL of the GIF in the requested format
gif_src
string
The media URL of the GIF in GIF format
preview
string
A preview image of the GIF
width
integer
Width of image
height
integer
Height of image
mp4
MP4 video
tinymp4
MP4 video in a smaller size
nanomp4
MP4 video in a very small size
loopedmp4
MP4 video that loops (same as mp4)
webm
WebM video
tinywebm
WebM video in a smaller size
nanowebm
WebM video in a very small size
gif
GIF image
mediumgif
GIF image in a medium size
tinygif
GIF image in a smaller size
nanogif
GIF image in a very small size
{ "id": "12409989992265318124", "title": "", "url": "https://tenor.com/view/tasha-steelz-gif-25509948", "src": "https://media.tenor.com/rDkkJaMgfuwAAAP4/tasha-steelz.webm", "gif_src": "https://media.tenor.com/rDkkJaMgfuwAAAAC/tasha-steelz.gif", "width": 150, "height": 84, "preview": "https://media.tenor.com/rDkkJaMgfuwAAAAD/tasha-steelz.png"}GET/guilds/{guild.id}/integrations
Returns a list of integration objects for the guild. Requires the permission.
has_commands?
boolean
Whether to only include Discord application integrations with registered commands (default false)
include_role_connections_metadata?
boolean
Whether to include integration role connection metadata (default false)
POST/guilds/{guild.id}/integrations
Enables an integration for the guild. Requires the permission. Returns a 204 empty response on success. Fires Guild Integrations Update and Integration Create Gateway events.
id
string
The ID of the integration account to enable
POST/guilds/{guild.id}/integrations/{integration.id}/sync
Syncs an integration for the guild. Requires the permission. Returns a 204 empty response on success. Fires Guild Integrations Update and Integration Update Gateway events.
PATCH/guilds/{guild.id}/integrations/{integration.id}
Modifies the behavior and settings of the integration in the guild. Requires the permission. Returns a 204 empty response on success. Fires Guild Integrations Update and Integration Update Gateway events.
expire_grace_period?
integer
The grace period before expiring subscribers (one of 1, 3, 7, 14, 30, in days)
enable_emoticons?
boolean
Whether emoticons should be synced for this integration (Twitch only)
DELETE/guilds/{guild.id}/integrations/{integration.id}
Removes the given integration ID from the guild. Deletes any associated webhooks and kicks the associated bot (if there is one). Requires the permission. Returns a 204 empty response on success. Fires Guild Integrations Update, Integration Delete, and optionally Guild Member Remove and Webhooks Update Gateway events.
POST/guilds/{guild.id}/migrate-command-scope
Migrates all Discord application integrations in the guild to the OAuth2 scope. Requires the permission. Fires a Guild Integrations Update and multiple Integration Update Gateway events.
integration_ids_with_app_commands
array[snowflake]
The IDs of migrated integrations that now have application commands registered
GET/users/@me/guilds/integration-application-ids
Returns a mapping of guild IDs to lists of application IDs attached to the integrations in the current user's guilds.
{ "81384788765712384": [ "157858575924985856", "157889000391180288", "157873248346832897", "157947794294833152", "173805066229252096" ], "1046920999469330512": []}GET/channels/{channel.id}/integrations
Returns a list of integration objects for the private channel.
DELETE/channels/{channel.id}/integrations/{integration.id}
Removes the given integration ID from the channel. Returns a 204 empty response on success. Fires an Integration Delete Gateway event.
POST/integrations/{integration.id}/join
Joins the user to the given integration ID's guild. Returns a 204 empty response on success. Fires a Guild Create Gateway event.
GET/integrations/tenor/search
Returns a list of up to 10 GIFs sourced from Tenor based on the provided query.
q
string
The search query to use
type
string
The type of the GIF (always gif)
url
string
The provider source URL of the GIF
src
string
The media URL of the GIF
width
integer
Width of image
height
integer
Height of image
[ { "type": "gif", "url": "https://tenor.com/bQ3Du.gif", "src": "https://media.tenor.com/RbG_9Eh9KLoAAAAS/alien-alien-reveal.gif", "width": 100, "height": 90 }]GET/gifs/trending-search
Returns a list of the top trending search terms.
limit? 1
integer
The maximum number of search terms to return (1-50, default 5)
locale?
string
The locale to use in search results (default en-US)
1 The limit is only a suggestion; the API may return fewer GIFs.
GET/gifs/suggest
Returns a list of recommended search terms based on the provided query.
q
string
The search query to use
limit? 1
integer
The maximum number of search terms to return (1-50, default 20)
locale?
string
The locale to use in search results (default en-US)
1 The limit is only a suggestion; the API may return fewer GIFs.
GET/gifs/search
Returns a list of GIF objects based on the provided query.
q
string
The search query to use
limit? 1
integer
The maximum number of GIFs to return (20-500)
media_format?
string
The media format to use (default mediumgif)
locale?
string
The locale to use in search results (default en-US)
1 The limit is only a suggestion; the API may return fewer GIFs.
GET/gifs/trending
Returns trending GIF categories and their associated preview GIFs.
media_format?
string
The media format to use (default mediumgif)
locale?
string
The locale to use in search results (default en-US)
name
string
The name of the category
src
string
The media URL of a preview GIF
{ "categories": [ { "name": "whatever", "src": "https://media.tenor.com/97c0UK_cAHMAAAAd/whatever-sassy.gif" } ], "gifs": [ { "id": "16750982996130936929", "title": "", "url": "https://tenor.com/view/peace-out-peace-sign-peace-ice-age-eddie-gif-16750982996130936929", "src": "https://media.tenor.com/6HdySNL-OGEAAAAC/peace-out-peace-sign.gif", "gif_src": "https://media.tenor.com/6HdySNL-OGEAAAAC/peace-out-peace-sign.gif", "width": 498, "height": 498, "preview": "https://media.tenor.com/6HdySNL-OGEAAAAD/peace-out-peace-sign.png" } ]}GET/gifs/trending-gifs
Returns a list of GIF objects that are currently trending.
limit? 1
integer
The maximum number of GIFs to return (20-500)
media_format?
string
The media format to use (default mediumgif)
locale?
string
The locale to use in search results (default en-US)
1 The limit is only a suggestion; the API may return fewer GIFs.
POST/gifs/select
Tracks the selection of a GIF by the user. Returns a 204 empty response on success.
id
string
The ID of the selected GIF
q
string
The search query used to find the GIF