Skip to main content

Documentation Index

Fetch the complete documentation index at: https://botpress.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Webchat component is a batteries-included implementation of the Webchat window. It contains most of what you’d expect when injecting Webchat.
The Webchat component doesn’t use the configuration set in your bot’s Dashboard. Instead, configure it using the configuration prop.
The <Webchat> component is incompatible with the useWebchat hook—using them together will cause issues and unexpected behaviour.If you need to use the hook, make sure you’re manually building Webchat.

Props

clientId
string
required
Your bot’s client ID.
storageKey
string
Custom key for Webchat’s local storage (if your bot’s configuration uses local storage)
user
UserCredentials
User to load Webchat with.
conversationId
string
Conversation ID to load Webchat with.
configuration
Configuration
Configuration for Webchat’s appearance and style. This object’s properties are similar to the Webchat configuration options available in the Dashboard.
Last modified on May 6, 2026