Skip to main content
Version: 0.37.71

APIGuildIntegration

Index

Properties

account

optionalapplication

The bot/OAuth2 application for discord integrations

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

This field is not provided for discord bot integrations.

optionalenable_emoticons

enable_emoticons?: boolean

Whether emoticons should be synced for this integration (twitch only currently)

This field is not provided for discord bot integrations.

enabled

enabled: boolean

Is this integration enabled

optionalexpire_behavior

expire_behavior?: IntegrationExpireBehavior

The behavior of expiring subscribers

optionalexpire_grace_period

expire_grace_period?: number

The grace period (in days) before expiring subscribers

This field is not provided for discord bot integrations.

id

id: string

Integration id

name

name: string

Integration name

optionalrevoked

revoked?: boolean

Has this integration been revoked

This field is not provided for discord bot integrations.

optionalrole_id

role_id?: string

ID that this integration uses for “subscribers”

This field is not provided for discord bot integrations.

optionalscopes

scopes?: OAuth2Scopes[]

The scopes the application has been authorized for

optionalsubscriber_count

subscriber_count?: number

How many subscribers this integration has

This field is not provided for discord bot integrations.

optionalsynced_at

synced_at?: string

When this integration was last synced

This field is not provided for discord bot integrations.

optionalsyncing

syncing?: boolean

Is this integration syncing

This field is not provided for discord bot integrations.

type

Integration type

optionaluser

user?: APIUser

User for this integration

Some older integrations may not have an attached user.

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