Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node interacts with the Chatwoot API to manage canned responses within a specified account. The "Get Many" operation for the "Canned Response" resource retrieves multiple canned responses associated with a given account ID.

Typical use cases include:

  • Fetching all predefined canned responses for an account to display or process them in workflows.
  • Automating support processes by retrieving quick reply templates stored in Chatwoot.
  • Synchronizing canned responses from Chatwoot into other systems or databases.

For example, a customer support automation workflow might use this node to pull all canned responses and then select appropriate replies based on incoming messages.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account whose canned responses you want to retrieve.
Continue on Fail Whether the node should continue executing subsequent items if this operation fails (true/false).

Output

The output is an array of JSON objects, each representing a canned response retrieved from the Chatwoot account. Each object corresponds to one canned response and contains all its details as returned by the Chatwoot API.

Example structure of each item in json output (fields depend on Chatwoot API response):

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

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Chatwoot API.
  • Needs an API authentication token configured in n8n credentials for Chatwoot.
  • The base URL of the Chatwoot instance must be set in the credentials.
  • The user must have access rights to the specified account ID in Chatwoot.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the API request to fail.
    • Network connectivity problems or incorrect base URL configuration may prevent successful API calls.
    • Insufficient permissions for the API token to read canned responses.

  • Error messages:

    • "Request failed with status code 404": The account ID may not exist or the endpoint URL is incorrect.
    • "Unauthorized" or "401 Unauthorized": The API key credential is invalid or missing.
    • "Request failed with status code 500": Server-side error; try again later or check Chatwoot server status.

  • Resolutions:

    • Verify the Account ID is correct and exists in Chatwoot.
    • Check that the API key credential is properly configured and has necessary permissions.
    • Confirm the Chatwoot base URL is accurate.
    • Enable "Continue on Fail" if you want the workflow to proceed despite individual errors.

Links and References

Discussion