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 and management of knowledge base articles within a customer support or documentation portal. For example, you can use this node to programmatically publish new help articles when content is created or updated in an external CMS, ensuring your Help Center stays current without manual intervention.

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.
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 JSON data representing the newly created article as returned by the API. This typically includes all article details such as IDs, content, metadata, and status. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Help Center service.
  • The node uses a base URL configured via credentials to connect to the Help Center API.
  • Proper permissions on the account and portal are necessary to create articles.

Troubleshooting

  • Missing Required Fields: Ensure Account Id and Portal Id are provided and valid; these are mandatory.
  • Invalid JSON in Meta: The Meta property expects valid JSON; malformed JSON will cause errors.
  • Permission Errors: If the API key lacks rights to add articles, the request will fail; verify API credentials and permissions.
  • API Connectivity Issues: Check network connectivity and correct base URL configuration if requests time out or fail.
  • Status Codes: Non-success HTTP responses indicate issues like invalid parameters or server errors; review error messages for specifics.

Links and References

  • Refer to your Help Center API documentation for detailed information on article creation endpoints and field definitions.
  • Consult n8n documentation on how to configure API credentials and handle JSON input properties.

Discussion