Skip to content

Chatwoot widget

The Chatwoot widget plugin is a user experience (UX) enhancement tool for webpages, integrating Chatwoot's live chat widget. It allows users to interact with customer support or sales teams directly from the webpage it's implemented on.




This plugin integrates a Chatwoot live chat widget into a webpage. The widget is powered by a user-provided Chatwoot token, which is essential for the widget's functionality. Once set up, the plugin injects a script into the webpage that initializes and displays the Chatwoot widget, allowing website visitors to start conversations. The widget enhances user engagement by providing a direct communication channel with the service team.

Inputs and Outputs

  • Inputs: The plugin takes a payload object, which serves as a container for passing data.
  • Outputs:
    • response: Outputs the same payload received as input, as this plugin primarily works by adding a UX element to the webpage.
    • error: Outputs in case of any execution error.


  • Token: Your Chatwoot token. This is a mandatory field. To find your token, log into, go to settings/inboxes, and look for the JavaScript configuration section.

JSON Configuration

Example configuration:

  "token": "your-chatwoot-token-here"

Required resources

This plugin does not require external resources to be configured.

Event prerequisites

Plugins like the Chatwoot widget, which fall under the "UIX Widgets" category, require a synchronous event. It will not work if sent event is asynchronous.


  • "Token can not be empty.": This error occurs when the Chatwoot token field is left empty during configuration. The token is essential for the widget to function, and thus it must be provided.
  • Generic errors related to script injection or execution failures might occur. These are less common and usually pertain to issues with the webpage where the script is being injected or network-related problems.