ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The Help Center: Update New Portal To Account operation in this custom n8n node allows you to update or configure a Help Center portal for a specific account within ChatWoot. This is useful for organizations that want to customize their support/help center experience, such as changing the appearance, supported languages, domain, and other portal settings.

Common scenarios include:

  • Updating branding (colors, header text) of your help center.
  • Changing the custom domain or homepage link for your support portal.
  • Enabling/disabling the portal (archived status).
  • Configuring localization options for multilingual support.

Practical example:
A SaaS company wants to rebrand its help center with new colors, a new header, and add Spanish as a supported language. They use this node to update the portal configuration automatically as part of their deployment workflow.


Properties

Display Name Type Description
Account Id Number The numeric ID of the account. Required.
Archived Boolean Status to check if portal is live.
Color String Header color for help-center (HEX string, e.g., "#fffff").
Config JSON Configuration about supporting locales (e.g., allowed_locales, default_locale).
Custom Domain String Custom domain to display help center.
Header Text String Help center header text.
Homepage Link String Link to main dashboard.
Name String Name for the portal.
Slug String Slug for the portal to display in link.
Page Title String Page title for the portal.

Output

The node returns a json object containing the updated portal information as received from the ChatWoot API. The structure typically includes:

{
  "id": 123,
  "account_id": 456,
  "name": "Support Portal",
  "slug": "support-portal",
  "archived": false,
  "color": "#ffffff",
  "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": "Welcome to Support"
  // ...other fields as returned by the API
}

Note: The actual output fields may vary depending on the ChatWoot API response.


Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Key/Credentials: Needs valid chatwootApi credentials configured in n8n, including the base URL ($credentials.url).
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid Account Id: If the provided Account Id does not exist, the API will likely return an error.
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
  • Malformed Config JSON: If the Config property is not valid JSON, the request will fail.
  • Domain/Slug Conflicts: Using a custom domain or slug that already exists may cause errors.

Error messages and resolutions:

  • "401 Unauthorized": Check your API credentials and ensure they are correct.
  • "404 Not Found": Verify the Account Id and endpoint URL.
  • "400 Bad Request": Ensure all required fields are filled and the JSON in Config is valid.
  • "409 Conflict": The custom domain or slug might already be in use; try a different value.

Links and References


Discussion