Conversations

Initiate Messenger

Initiates conversation with the messenger integration

post

/v1/integration/messenger/{messengerIntegrationId}/initiate

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Request Body * Required

Request Body Schema: application/json

pageIdstring

The Facebook Page ID sending the message

recipientIdstring

The Messenger recipient PSID from a prior interaction

textstring

The free-form text message to send while Meta allows messaging this recipient


import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({
secret: process.env.CHATBOTKIT_API_KEY!
})

const response = await cbk.integration.messenger.initiate(
messengerIntegrationId, 
{"pageId":"string",
"recipientId":"string",
"text":"string"
}
)

{"id":"string"
}

The messenger integration was successfully initiated

Go to cbk.ai