This page contains a reference for all methods available when injecting Webchat.
open
The window.botpress.open method opens the Webchat window:
It becomes available after Webchat has been initialized.
Parameters
The open method takes no parameters.
Returns
close
The window.botpress.close method closes the Webchat window:
It becomes available after Webchat has been initialized.
Parameters
The close method takes no parameters.
Returns
toggle
The window.botpress.toggle method toggles the Webchat window open/closed depending on its current state:
window.botpress.toggle();
Parameters
The toggle method takes no parameters.
Returns
updateUser
The asynchronous window.botpress.updateUser method updates the data associated with the current Webchat user:
await window.botpress.updateUser({
name: "<string>",
pictureUrl: "<string>",
data: {},
userKey: "<string>"
});
Parameters
The user attributes to update.
URL pointing to a picture for the user.
An object containing any additional data as key-value pairs. The values can be of any type.
A custom key to associate with the user.
By default, the user object contains the following properties:
Unique identifier for the user.
User creation timestamp in ISO 8601 format.
Last user update timestamp in ISO 8601 format.
Returns
A Promise that resolves void when the user data has been successfully updated.
getUser
The asynchronous window.botpress.getUser method gets the data associated with the current Webchat user:
await window.botpress.getUser();
Parameters
The getUser method takes no parameters.
Returns
A Promise that resolves when the user information has been retrieved.
Unique identifier for the user.
User creation timestamp in ISO 8601 format.
Last user update timestamp in ISO 8601 format.
URL pointing to a picture for the user.
An object containing any additional data as key-value pairs. The values can be of any type.
A custom key to associate with the user.
config
The window.botpress.config method updates Webchat’s configuration and the current user’s data.
window.botpress.config({
configuration: {},
user: {}
});
Parameters
An object containing the Webchat configuration and user data to update.
Webchat configuration settings to update.
Name of the bot displayed in the Webchat header.
URL to the bot’s avatar image.
Placeholder text for the message input field.
Primary color theme for the webchat interface as a HEX code.
Theme mode. Can be light or dark.
Visual variant. Can be solid or soft.
Whether to enable file upload functionality.
Whether to show “Powered by Botpress” branding.
Whether to enable message feedback functionality.
URL to the Floating Action Button (FAB) image.
Border radius for the webchat interface. Must be between 0.5 and 4.
Custom font family for the webchat interface. Can be one of the default fonts:"inter" | "rubik" | "ibm plex sans" | "fira code"or any Google Font.Google Font titles are case-sensitive.
Custom CSS styles to apply to the webchat interface.
URL to an external stylesheet to load for the webchat interface.
Storage location for webchat data. Can be localStorage or sessionStorage.
Custom footer content for the webchat interface.
Header visual variant. Can be solid or glass.
Admin key for enhanced permissions and functionality.
Phone contact information object.
Display title for the phone contact.
Phone number or link for the contact.
Email contact information object.
Display title for the email contact.
Email address or mailto link for the contact.
Website contact information object.
Display title for the website contact.
Website URL for the contact.
Terms of service link object.
Display title for the terms of service link.
URL to the terms of service page.
Privacy policy link object.
Display title for the privacy policy link.
URL to the privacy policy page.
If you omit the configuration object or leave any fields blank, they will default to the Webchat configuration set in your Dashboard.
User data to update.
URL pointing to a picture for the user.
An object containing any additional data as key-value pairs. The values can be of any type.
A custom key to associate with the user.
Returns
restartConversation
The asynchronous window.botpress.restartConversation method ends the current conversation and starts a new one:
await window.botpress.restartConversation();
Parameters
The restartConversation method takes no parameters.
Returns
A Promise that resolves to void when a new conversation has been successfully created.
sendMessage
The asynchronous window.botpress.sendMessage method sends a new message to your bot on behalf of the current user:
await window.botpress.sendMessage("<string>");
Parameters
The message to send to the bot.
Returns
A Promise that resolves to void when the message has successfully been sent.
sendEvent
The asynchronous window.botpress.sendEvent method sends a new event to your bot:
await window.botpress.sendEvent({});
Parameters
An object containing custom data to send to the bot. Can contain any key-value pairs.
Returns
A Promise that resolves to void when the event has successfully been sent.
setUnreadMessageCount
The window.botpress.setUnreadMessageCount method sets the number of unread messages to display on the Floating Action Button (FAB):
window.botpress.setUnreadMessageCount(123);
Parameters
The number of unread messages to display on the FAB.
Returns
The window.botpress.on method sets up an event listener for a given Webchat event:
window.botpress.on('<string>', (event) => {});
Parameters
The event type to listen for. Can be any of the following event types:| Event | Description |
|---|
conversation | Fires when a new conversation starts |
message | Fires when a message is sent |
error | Fires when an error occurs |
customEvent | Fires for custom events |
webchat:initialized | Fires when Webchat has finished loading and is ready to be opened |
webchat:ready | Fires when Webchat has been opened for the first time and is ready to receive messages |
webchat:opened | Fires when Webchat is opened |
webchat:closed | Fires when Webchat is closed |
* | Fires for any event (receives all events) |
Callback function that gets called when the event occurs. The function receives event data specific to each event type as its parameter.
Returns
An unsubscribe function that can be called to remove the event listener.
