ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node allows updating the configuration of a Help Center portal associated with a specific account in ChatWoot. It is useful for managing the appearance and settings of a customer-facing help center, such as changing its name, header text, color theme, supported languages, and domain. Typical use cases include customizing the help center to match branding guidelines, enabling or disabling the portal, or updating localization options.

For example, a user might update the portal to change the header color to their brand’s primary color, set the default language to English, add Spanish as an allowed locale, and specify a custom domain where the help center is hosted.

Properties

Name Meaning
Account Id The numeric ID of the account whose help center portal is being updated (required).
Archived Boolean flag indicating whether the portal is archived (not live) or active (live).
Color Hexadecimal color string representing the header color of the help center (e.g., "#ffffff").
Config JSON object specifying configuration details about supported locales, including allowed locales and default locale. Example: {"allowed_locales":["en","es"],"default_locale":"en"}
Custom Domain URL string specifying a custom domain to display the help center on.
Header Text Text string to be displayed in the help center header.
Homepage Link URL string linking to the main dashboard or homepage related to the help center.
Name Name of the help center portal.
Slug URL slug used to display the portal link.
Page Title Title text for the help center page.

Output

The node outputs JSON data representing the updated state of the help center portal after the update operation. This typically includes all the properties sent in the request along with any additional metadata returned by the API, such as timestamps or status indicators.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • Depends on the ChatWoot REST API endpoint for updating help center portals.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will likely return an error. Verify the account ID before running the node.
  • Malformed JSON in Config: The config property expects valid JSON. Invalid JSON syntax will cause parsing errors. Ensure the JSON is well-formed.
  • Unauthorized Access: Missing or invalid API credentials will result in authentication errors. Confirm that the API key and base URL are correctly configured.
  • Invalid Color Format: The color property should be a valid HEX color string (e.g., "#ff0000"). Incorrect formats may be rejected.
  • Network Issues: Connectivity problems to the ChatWoot server will cause request failures. Check network access and server availability.

Links and References

Discussion