Load the chat widget

Last updated May 14, 2019


This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

Load the widget for the first time on the page. If the widget is currently loaded, subsequent calls to this method are no-ops.

This method is only necessary if you set the loadImmediately flag to false in hsConversationsSettings. Otherwise, the widget will load itself automatically.

Note: This is not the same as opening the widget. See window.open if you want to manually open the widget after it's loaded.

Optional Parameters How to use Description
Open widget "widgetOpen": false Whether the widget should load in an open state. Defaults to false.