There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Set Conversation settings

Last updated June 17, 2020

hsConversationsSettings = { :settings: }

hsConversationsSettings can be used to provide configuration options to the Conversations API before it initializes.

Usage of this is entirely optional. This object must be set before the Conversations API is loaded. This will have no effect if set after window.HubSpotConversations is loaded.


Optional Parameters How to use Description
Load Immediately "loadImmediately": true Whether the widget should implicitly load or wait until the widget.load() method is called. Defaults to true.
Inline embed selector "inlineEmbedSelector": Where the widget should be embedded in the page. If a selector (e.g. #some-id) is provided, the widget will be embedded inline within that DOM node. It will always be open until it is removed via widget.remove
Enable cookie banner "enableWidgetCookieBanner":true Whether or not the cookie banner will be enabled for all chatflows on the page.
Defaults to false.
Disable attachments "disableAttachment":true Whether or not the upload attachment button should be hidden in the chat widget.
Defaults to false.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example usage: window.hsConversationsSettings = { loadImmediately: false, // Allows you to manually load the widget using .load() inlineEmbedSelector: '#my-chat-div', enableWidgetCookieBanner: true, disableAttachment: true }; /* ... */ window.HubSpotConversations.widget.load();