Conversations

Initiate Whatsapp

Initiates conversation with the whatsapp integration

post
/v1/integration/whatsapp/{whatsappIntegrationId}/initiate

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Request Body * Required

Request Body Schema: application/json

tostring

The recipient phone number in E.164 format, without the leading plus sign

textstring

The free-form text message to send within an active WhatsApp customer service window

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.integration.whatsapp.initiate(

whatsappIntegrationId,
{
"to":"string",
"text":"string"
}
)
{
"id":"string"
}
The whatsapp integration was successfully initiated