WhatsApp Integration

Create WhatsApp integration

post/integration/whatsapp/create

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/whatsapp/create
  • Auth: HTTP bearer

Request body

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

blueprintIdstring nullable

The ID of the blueprint

botIdstring nullable

The ID of the bot this configuration is using

phoneNumberIdstring nullable

The WhatsApp integration phone number ID

accessTokenstring nullable

The WhatsApp integration access token

appSecretstring nullable

The Meta app secret used to validate webhook signatures

contactCollectionboolean

Weather to collect contacts

sessionDurationnumber nullable

The session duration (in milliseconds)

attachmentsboolean

Weather the bot supports attachments

allowFromstring nullable

Newline-or-comma-separated list of allowed senders. Use E.164 phone numbers with or without the leading +. Set to * to allow all. Leave empty to deny all.

Response

The WhatsApp integration was created successfully

idstring required

The ID of the WhatsApp Integration

Changes

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