Chatwoot

Overview

This node integrates with the Chatwoot API to manage canned responses within a specified account. Specifically, the Create operation under the Canned Response resource allows users to create new predefined message templates (canned responses) that can be reused in conversations or messaging workflows.

Common scenarios where this node is beneficial include:

• Automating customer support replies by creating standard response templates.
• Quickly setting up frequently used messages for agents to improve response time.
• Managing and updating canned responses programmatically as part of a larger workflow.

For example, a user could create a canned response with a short code "greeting" and content "Hello! How can I assist you today?" to quickly insert this message into conversations.

Properties

Output

The output of this node is a JSON object representing the newly created canned response as returned by the Chatwoot API. This typically includes details such as the canned response's ID, short code, content, timestamps, and other metadata provided by the API.

Example output structure (simplified):

{
  "id": 123,
  "short_code": "greeting",
  "content": "Hello! How can I assist you today?",
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-01T12:00:00Z"
}

No binary data output is involved in this operation.

Dependencies

• Requires an active Chatwoot account and valid API credentials (an API key or token) configured in n8n.
• The node makes HTTP requests to the Chatwoot API endpoint /api/v1/accounts/{accountId}/canned_responses.
• The base URL for the Chatwoot instance must be set in the credentials configuration.

Troubleshooting

• Common issues:

  • Invalid or missing Account ID: Ensure the numeric account ID is correct and corresponds to an existing Chatwoot account.
  • Authentication errors: Verify that the API credentials are correctly configured and have sufficient permissions.
  • Duplicate short codes: The API may reject creation if the short code already exists; use unique short codes.
  • Network or connectivity problems: Check network access to the Chatwoot API endpoint.

• Error messages:

  • "401 Unauthorized": Indicates invalid or missing API authentication. Resolve by updating credentials.
  • "404 Not Found": The specified account ID does not exist or the endpoint is incorrect.
  • "422 Unprocessable Entity": Validation error, often due to missing required fields like short code or content.
  • "500 Internal Server Error": Server-side issue; retry later or contact Chatwoot support.

• If Continue on Fail is enabled, the node will output error details in the JSON field instead of stopping execution.

Links and References

• Chatwoot API Documentation - Canned Responses
• n8n Documentation - Creating Custom Nodes
• Chatwoot Official Website