Discord Integration

Fetch a discordIntegration

get/integration/discord/{discordIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/discord/{discordIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

discordIntegrationIdstring required

The ID of the Discord integration to retrieve

Response

The Discord integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

botIdstring nullable

The ID of the bot this configuration is using

blueprintIdstring nullable

The ID of the blueprint

appIdstring

The Discord application ID

handlestring

The Discord command handle

contactCollectionboolean

Weather to collect contacts

sessionDurationnumber

The chat session duration

allowFromstring

Restrict which Discord users can interact with this integration. Accepts Discord user IDs (17-18 digit snowflakes) or @username, one per line. Use * to allow all senders. Leave empty to deny all.

Changes

No recorded changes to this operation across all 1 revision of this API.