ChatWoot

Overview

This node allows you to add a new Help Center portal to a specific account in ChatWoot. It is useful for organizations that want to programmatically create and configure help center portals, such as when onboarding new clients or automating support infrastructure setup. For example, you could use this node to automatically provision a branded help center whenever a new customer signs up.

Properties

The following input properties are supported for the "Add New Portal To Account" operation under the "Help Center" resource:

Output

The output will be a json object containing the details of the newly created Help Center portal. The structure typically includes fields such as the portal's ID, name, slug, configuration, and other metadata returned by the ChatWoot API. The exact structure depends on the API response but generally reflects the submitted properties along with system-generated values (like IDs and timestamps).

Example output:

{
  "id": 123,
  "name": "Support Portal",
  "slug": "support-portal",
  "color": "#ffffff",
  "archived": false,
  "config": {
    "allowed_locales": ["en", "es"],
    "default_locale": "en"
  },
  "custom_domain": "https://help.example.com",
  "header_text": "Handbook",
  "homepage_link": "https://www.example.com/",
  "page_title": "Support Home",
  // ...other fields
}

Note: This node does not output binary data.

Dependencies

• External Service: Requires access to a ChatWoot instance.
• API Key: You must provide valid ChatWoot API credentials (chatwootApi).
• n8n Configuration: The base URL for ChatWoot should be set in the credentials as url.

Troubleshooting

• Missing or Invalid Credentials:
  Error message: "401 Unauthorized" or "Invalid credentials."
  Resolution: Ensure your ChatWoot API key and URL are correct in n8n credentials.

• Required Fields Missing:
  Error message: "account_id is required" or similar.
  Resolution: Make sure all required fields, especially "Account Id", are provided.

• Invalid Field Values:
  Error message: "Invalid color format" or "Malformed config JSON".
  Resolution: Double-check that the color is a valid HEX string and the config is valid JSON.

• Network/Connection Issues:
  Error message: "Could not connect to server" or timeouts.
  Resolution: Verify network connectivity and that the ChatWoot instance is reachable from n8n.

Links and References

• ChatWoot Documentation
• n8n Documentation
• ChatWoot API Reference