ChatWoot

Overview

This n8n node operation, "Add New Category To Account" under the Help Center resource, allows users to create a new category within a specified account and portal in ChatWoot's Help Center. This is useful for organizing help center content into categories, such as product documentation or support topics, and supports multilingual and hierarchical structures.

Common scenarios:

• Setting up a new section in your help center for a product or feature.
• Organizing documentation by language or region.
• Structuring categories with parent-child relationships for better navigation.

Practical example:
A SaaS company wants to add a "Getting Started" category (in English and Spanish) to their customer support portal, associating it with existing categories and defining its position in the list.

---

Properties

Below are the input properties supported by this operation:

Display Name	Type	Description
Account Id	Number	The numeric ID of the account where the category will be added. (Required)
Portal Id	Number	The Portal ID parameter specifying which portal the category belongs to. (Required)
Description	String	Category description.
Locale	String	Category locale (e.g., "en", "es"). Indicates the language of the category.
Name	String	Category name. The visible title of the category.
Slug	String	Category slug. A URL-friendly identifier for the category.
Position	Number	Category position in the portal list to sort. Determines display order.
Associated Category Id	Number	To associate similar categories, e.g., same category in different languages.
Parent Category Id	Number	To define a parent category, enabling multi-level category hierarchies.

---

Output

The output of this operation is a JSON object representing the newly created category. While the exact structure depends on the ChatWoot API response, you can expect fields such as:

{
  "id": 123,
  "name": "Getting Started",
  "description": "Introductory resources for new users.",
  "locale": "en",
  "slug": "getting-started",
  "position": 1,
  "portal_id": 456,
  "account_id": 789,
  "associated_category_id": 0,
  "parent_category_id": 0,
  // ...other metadata fields from ChatWoot
}

If the API returns errors, the output may include an error message field.

---

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure the chatwootApi credential in n8n, including the base URL and authentication token.
• n8n Configuration: Ensure the node has network access to your ChatWoot server.

---

Troubleshooting

Common issues:

• Missing or invalid credentials: If the chatwootApi credential is not set or incorrect, the node will fail to authenticate.
• Invalid Account or Portal ID: Supplying non-existent IDs will result in API errors.
• Duplicate Slug: If the slug already exists, the API may reject the request.
• Insufficient permissions: The API key used must have rights to create categories.

Common error messages:

• "401 Unauthorized": Check your API credentials.
• "404 Not Found": Verify that the provided Account Id and Portal Id exist.
• "422 Unprocessable Entity": Likely due to missing required fields or duplicate slugs; check your input values.

---

Links and References

• ChatWoot API Documentation – Categories
• n8n Documentation – Custom Nodes
• ChatWoot Help Center

---