ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to add a new category to a Help Center account portal. It is useful for organizing content within a customer support or knowledge base system by creating categorized sections. For example, you might use this node to create categories such as "Product Documentation," "FAQs," or "Troubleshooting Guides" within your Help Center portal, helping users navigate and find relevant information more easily.

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 in which the category will be created.
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 (slug).
Position Numeric position to determine the order of the category in the portal list.
Associated Category Id An ID to associate this category with similar categories, e.g., same category in different languages.
Parent Category Id The ID of a parent category to create hierarchical category structures (multi-level categories).

Output

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

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in credentials.
  • Depends on the ChatWoot API being accessible and properly configured to accept category creation requests.

Troubleshooting

  • Common issues:
    • Invalid or missing Account Id or Portal Id can cause request failures.
    • Incorrect API credentials or base URL will result in authentication errors.
    • Providing invalid values for fields like locale or slug may cause validation errors.
  • Error messages:
    • Authentication errors usually indicate problems with the API key or URL configuration.
    • Validation errors from the API will specify which input property is incorrect or missing.
  • Resolutions:
    • Verify that the Account Id and Portal Id are correct and exist in your ChatWoot instance.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Double-check the format and allowed values for properties like locale and slug.

Links and References

Discussion