Messenger Integrations
Create Messenger Integration
Create Messenger integration
Authorization
ChatBotKit API Secret * Required
HTTP Authorization Scheme: bearer
Request Body * Required
Request Body Schema: application/json
aliasstring
The unique alias for the instance
namestring
The associated name
descriptionstring
The associated description
metaobject
Meta data information
blueprintIdstring
The ID of the blueprint
botIdstring
The ID of the bot this configuration is using
accessTokenstring
The Messenger integration access token
appSecretstring
The Meta app secret used to validate webhook signatures
contactCollectionboolean
Whether to collect contacts
sessionDurationnumber
The session duration (in milliseconds)
attachmentsboolean
Whether the bot supports attachments
autoRespondstring
When the bot replies to messages that are not addressed to it. Direct messages and mentions of the bot always get a reply. Leave empty to reply only when addressed (the bot keeps replying in conversations it is already part of), use '@all' to reply to every message, '@auto' to let the bot decide from its name, description and backstory, or write instructions describing which messages to reply to ('@agent <instructions>' is accepted and treated the same). Stored for consistency with other integrations; this integration does not apply it yet and answers every message it receives as before.
import { ChatBotKit } from '@chatbotkit/sdk'
const cbk = new ChatBotKit({
token: process.env.CHATBOTKIT_API_TOKEN!
})
const response = await cbk.integration.messenger.create(
{)"alias":"string","name":"string","description":"string","meta":"object","blueprintId":"string","botId":"string","accessToken":"string","appSecret":"string","contactCollection":"boolean","sessionDuration":"number","attachments":"boolean",}"autoRespond":"string"
{"id":"string"}