ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Canned Responses → Get Account Canned Response

AI-generated

Overview

This node interacts with the ChatWoot API to retrieve canned responses associated with a specific account. The "Get Account Canned Response" operation fetches predefined message templates (canned responses) that can be used for quick replies in customer support scenarios. This is useful for support agents or automated workflows that need to access and utilize standardized responses efficiently.

Practical examples include:

  • Automatically fetching canned responses to suggest replies in a chatbot.
  • Integrating with helpdesk systems to display available response templates.
  • Using canned responses in automation workflows to maintain consistent communication.

Properties

Name Meaning
Account Id The numeric ID of the account to fetch canned responses from.

Output

The node outputs JSON data containing the list of canned responses retrieved from the specified account. Each item in the output typically includes details such as the response text, identifier, and any metadata related to the canned response.

If the node supports binary data output, it would represent attachments or media linked to canned responses, but based on the provided code and context, the output focuses on JSON structured data representing canned responses.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the node credentials.
  • Depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.
  • Uses an OpenAPI specification (openapi.json) bundled with the node for request definitions.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent Account Id may result in empty responses or errors.
    • Network connectivity problems to the ChatWoot server can cause request timeouts.
  • Error messages:

    • Authentication errors typically indicate invalid API keys or misconfigured credentials.
    • "Account not found" or similar errors suggest the Account Id does not exist or is inaccessible.
    • JSON parsing errors might occur if the API response format changes unexpectedly.

To resolve these:

  • Verify API credentials and ensure they have proper permissions.
  • Confirm the Account Id is correct and accessible.
  • Check network connectivity and ChatWoot server status.

Links and References

Discussion