Refresh the chat widget

Last updated March 26, 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.

Refresh and re-render the widget's information, given the current page url.

If you house the chat widget on a single-page application, this method can be useful to refresh the widget on route changes. This allows you to specify different chatflows on different page routes. If widget.refresh is called on a route where there is no chatflow, the widget will be removed.

  • widget.refresh will preserve any existing conversations that a page visitor has started in the widget.
  • widget.refresh is throttled to one call per second.