Chatwoot

Overview

This node interacts with the Chatwoot API to manage canned responses within a specified account. The "Get" operation for the "Canned Response" resource retrieves detailed information about a specific canned response by its numeric ID. This is useful when you want to fetch and use predefined message templates (canned responses) in your workflows, such as sending quick replies or automating customer support messages.

Practical example:
You have a set of canned responses for common customer queries stored in Chatwoot. Using this node, you can retrieve a particular canned response by its ID during a workflow execution to dynamically insert that message content into a conversation or notification.

Properties

Output

The output contains a JSON object representing the canned response retrieved from the Chatwoot API. This includes all details of the canned response such as its ID, short code, content, timestamps, and any other metadata provided by the API.

Example structure of the json output field (simplified):

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

No binary data is output by this node.

Dependencies

• Requires an active Chatwoot account and API access.
• Needs an API authentication token configured in n8n credentials to authorize requests to the Chatwoot API.
• The base URL of the Chatwoot instance must be configured in the credentials.

Troubleshooting

• Common issues:

  • Invalid or missing Account ID or Canned Response ID will cause the API request to fail.
  • Network connectivity problems or incorrect API base URL configuration can prevent successful API calls.
  • Insufficient permissions or invalid API token may result in authorization errors.

• Error messages:

  • "404 Not Found": The specified canned response or account does not exist. Verify the IDs.
  • "401 Unauthorized": Authentication failed. Check the API token and credential setup.
  • "400 Bad Request": Input parameters are invalid or missing. Ensure required fields are correctly set.

• Resolution tips:

  • Double-check that the Account ID and Canned Response ID are correct and correspond to existing resources.
  • Confirm that the API key credential is valid and has necessary permissions.
  • Enable "Continue on Fail" if you want the workflow to proceed despite individual item failures.

Links and References

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