ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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 loading canned responses for an account to present options in a chatbot.
  • Fetching response templates to insert into outgoing messages in a helpdesk automation.
  • Synchronizing canned responses from ChatWoot into another system for backup or analysis.

Properties

Name Meaning
Account Id The numeric ID of the account whose canned responses you want to retrieve

Output

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

If the node supports binary data output, it would generally relate to attachments or media linked to canned responses, but this is not indicated in the provided code snippet.

Dependencies

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

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 can prevent successful API calls.
  • 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.
    • Timeout or connection errors imply network issues; verify endpoint accessibility.

To resolve these, ensure valid credentials are set up, confirm the Account Id is correct, and check network connectivity to the ChatWoot server.

Links and References

Discussion