ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to add a new category to a Help Center account within a portal. It is useful for organizing content in a customer support or knowledge base system by creating categorized sections that help users find relevant articles more easily. For example, you might use this node to add a "Product Documentation" category under a specific account and portal, enabling better content management and navigation.

Properties

Name Meaning
Account Id The numeric ID of the account where the category will be added.
Portal Id The numeric ID of the portal associated with the Help Center.
Description A textual description of the category.
Locale The locale/language code for the category (e.g., "en", "es").
Name The name/title of the category.
Slug A URL-friendly identifier for the category.
Position Numeric position to sort the category within the portal's category list.
Associated Category Id An optional ID to associate this category with similar categories, e.g., same category in different languages.
Parent Category Id An optional ID to define a parent category, allowing hierarchical categorization (multi-level categories).

Output

The node outputs JSON data representing the newly created category object as returned by the API. This typically includes details such as the category ID, name, description, locale, slug, position, and any associations or parent-child relationships established. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node uses the ChatWoot API base URL configured in credentials.
  • The operation depends on the external ChatWoot Help Center API endpoint for adding categories.

Troubleshooting

  • Common issues:
    • Missing or invalid Account Id or Portal Id can cause request failures.
    • Providing invalid locale codes or slugs may result in API errors.
    • Attempting to associate or set a parent category with non-existent IDs will likely fail.
  • Error messages:
    • Authentication errors if the API key is missing or incorrect.
    • Validation errors from the API if required fields like name or account_id are missing.
    • Network or connectivity errors if the base URL is misconfigured.
  • Resolutions:
    • Ensure all required fields are correctly filled.
    • Verify API credentials and base URL configuration.
    • Confirm referenced category IDs exist before associating or nesting.

Links and References

Discussion