ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to add a new article to a Help Center account. It is useful for automating the creation of knowledge base articles within a customer support or self-service portal. For example, you can use this node to programmatically publish new help articles when new product features are released or to bulk import existing documentation into your Help Center.

Properties

Name Meaning
Account Id The numeric ID of the account where the article will be added.
Portal Id The Portal ID parameter identifying the specific Help Center portal.
Content The main text content of the article.
Meta JSON object used for search optimization, including tags, title, and description of the article.
Position Numeric position of the article within its category (ordering).
Status Numeric status code representing the article's publication state.
Title The title of the article.
Slug URL-friendly string identifier for the article.
Views Number of views the article has received (can be set initially).
Author Id Numeric ID of the author who created the article.
Category Id Numeric ID of the category under which the article is classified.
Folder Id Numeric ID of the folder containing the article.
Associated Article Id Numeric ID of another article to associate with this one, e.g., for related references.

Output

The node outputs a JSON object representing the newly created article, including all properties sent in the request plus any additional metadata returned by the API (such as unique article ID, timestamps, etc.). There is no binary data output.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node uses the ChatWoot API endpoint configured via credentials, specifically targeting the Help Center resource.
  • Proper configuration of the base URL and authentication token is necessary in n8n credentials.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id and Portal Id are provided and valid numeric values; otherwise, the API may reject the request.
  • Invalid JSON in Meta: The Meta property expects a valid JSON string. Malformed JSON will cause parsing errors.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has permissions to create articles.
  • Status Codes: If the API returns errors related to status codes or positions, check that these numeric values conform to expected ranges defined by the API.
  • Slug Conflicts: Duplicate slugs might cause conflicts; ensure uniqueness if required by the API.

Links and References

Discussion