Webchat Customization


Styling Webchat

In this article, we will explore how to customize the behavior and appearance of the web chat. By default, the web chat comes with a set of pre-defined styles and options, but you can customize it to better suit your needs.

Configuring the Web Chat

You should select the Configurable option if you want to customize the web chat configuration.

// Include the Botpress Web Chat library
<script src=""></script>
// Initialize the web chat with default options
      "botId": "539dd4de-aaa1-4a46-9218-95f32b2a1e3f",
      "hostUrl": "",
      "messagingUrl": "",
      "clientId": "539de4de-aea1-4a46-9218-95f32b2a1e3f",
      "botName": "Wonderful-chatbot"

To add your own CSS styling, you must upload your CSS file to your server and add it's url to the stylesheet parameter.

The configuration object passed to the .init() accepts the following available options which you can pass to customize the behavior of the web chat:

Customization VariableVariable typeDefault valueDescription
stylesheetstring-Provide a path to a stylesheet to customize the web chat
showConversationsButtonbooleantrueIf false, will hide the conversation list pane
showTimestampbooleanfalseIf true, will display a timestamp under each messages
enableTranscriptDownloadbooleantrueAllows the user to download the conversation history
enableConversationDeletionbooleanfalseAllows the user to delete its conversation history
closeOnEscapebooleantrueClose the web chat when pressing the Esc key
botNamestring-Displays the bot name to the right of its avatar
composerPlaceholderstring'Reply to {botname}'Allows to set a custom composer placeholder
avatarUrlstring-Allow to specify a custom URL for the bot's avatar
localestring'browser'Force the display language of the web chat (en, fr, ar, ru, etc..)
Defaults to the user's browser language if not set
Set to 'browser' to force use the browser's language
botConversationDescriptionstring-Small description written under the bot's name
hideWidgetbooleanfalseWhen true, the widget button to open the chat is hidden
disableAnimationsbooleanfalseDisable the slide in / out animations of the web chat
useSessionStoragebooleanfalseUse sessionStorage instead of localStorage, which means the session expires when tab is closed
enablePersistHistorybooleantrueWhen enabled, sent messages are persisted to local storage (recall previous messages)
classNamestring-CSS class to be applied to iframe
disableNotificationSoundbooleanfalseIf true, chat will no longer play the notification sound for new messages.
googleMapsAPIKeystring-Google Maps API Key required to display the map. It will display a link to Google Maps otherwise.
websitestring-Displays the bot's website in the conversation page
phoneNumberstring-Displays the bot's contact phone number in the conversation page
termsConditionsstring-Displays the bot's terms of service in the conversation page
privacyPolicystring-Displays the bot's privacy policy in the conversation page
emailAddressstring-Displays the bot's email address in the conversation page.
coverPictureUrlstring-Displays the bot's cover picture in the conversation page
showBotInfoPagebooleanfalseEnables the bot's information page in the web chat
showCloseButtonbooleantrueDisplay's the web chat close button when the web chat is opened

Styling the Web Chat

This CSS code includes styles for a chatbot widget

Class NameDescription
.bpw-layoutSets the height, position, border, border-radius, and z-index of the chatbot widget.
.bpw-header-titleSets the font color of the chatbot header title to white.
.bpw-from-bot .bpw-chat-bubble .bpw-chat-bubble-contentSets the font color and background color of the chatbot message bubbles from the bot.
.bpw-header-iconSets the fill color of the chatbot header icon to white when hovered over.
.bpw-header-containerSets the border, background color, and border radius of the chatbot header container.
.bpw-header-title-container .bpw-bot-avatarHides the bot avatar in the chatbot header title container.
aSets the font color of links in the chatbot widget to white and changes color to light gray when hovered over.
.bpw-from-user .bpw-chat-bubble .bpw-chat-bubble-contentSets the background color and border radius of the chatbot message bubbles from the user.
#botpress-tooltip-1, #botpress-tooltip-37Hides the tooltips for the chatbot widget.
.bpw-send-buttonSets the appearance and position of the chatbot send button.
.bpw-poweredHides the powered by Botpress logo in the chatbot widget.
.bpw-card-actionSets the font weight, color, and border of the action buttons in the chatbot card carousel.
.bpw-card-containerSets the border of the chatbot card carousel.
.bpw-keyboard-quick_replySets the background color and padding of the chatbot quick reply buttons.
.bpw-buttonSets the appearance and font of the chatbot quick reply buttons.
.bpw-widget-btnSets the appearance and background image of the chatbot widget button.
.bpw-floating-buttonRemoves the box shadow from the chatbot widget button.

Go to next chapters to learn more about how to configure these classes.