Preview environment

interface APIGuildIntegration

export interface APIGuildIntegration

See also: https://discord.com/developers/docs/resources/guild#integration-object

account : APIIntegrationAccount

Integration account information

See also: https://discord.com/developers/docs/resources/guild#integration-account-object

optional
application? : APIGuildIntegrationApplication

The bot/OAuth2 application for discord integrations

See also: https://discord.com/developers/docs/resources/guild#integration-application-object**This field is not provided for discord bot integrations.**

optional
enable_emoticons? : boolean

Whether emoticons should be synced for this integration (twitch only currently)**This field is not provided for discord bot integrations.**

enabled : boolean

Is this integration enabled

optional
expire_behavior? : IntegrationExpireBehavior

The behavior of expiring subscribers**This field is not provided for discord bot integrations.**

See also: https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors

optional
expire_grace_period? : number

The grace period (in days) before expiring subscribers**This field is not provided for discord bot integrations.**

id : Snowflake

Integration id

name : string

Integration name

optional
revoked? : boolean

Has this integration been revoked**This field is not provided for discord bot integrations.**

optional
role_id? : Snowflake

ID that this integration uses for "subscribers"**This field is not provided for discord bot integrations.**

optional
scopes? : OAuth2Scopes[]

The scopes the application has been authorized for

optional
subscriber_count? : number

How many subscribers this integration has**This field is not provided for discord bot integrations.**

optional
synced_at? : string

When this integration was last synced**This field is not provided for discord bot integrations.**

optional
syncing? : boolean

Is this integration syncing**This field is not provided for discord bot integrations.**

type : APIGuildIntegrationType

Integration type

optional
user? : APIUser

User for this integration**Some older integrations may not have an attached user.**

See also: https://discord.com/developers/docs/resources/user#user-object