There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Load the chat widget

Last updated June 17, 2020


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 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.