Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage canned responses within a specified account. The Update operation for the Canned Response resource allows users to modify an existing canned response by changing its short code and/or content.

Typical use cases include:

  • Updating predefined message templates used by support agents to ensure responses remain accurate and relevant.
  • Modifying quick reply messages without manually editing them in the Chatwoot dashboard.
  • Automating updates to canned responses as part of a workflow, e.g., adjusting greetings or instructions based on time or campaign.

Example: You have a canned response with ID 123 in account 1 that says "Hello! How can I assist you today?" You want to update its short code to "welcome" and change the content to "Hi there! How may I help you?".

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account where the canned response exists.
Canned Response ID The numeric ID of the canned response to update.
Short Code (Optional) The new short code identifier for the canned response.
Content (Optional) The new content text of the canned response.
Continue on Fail Whether to continue executing subsequent items if this update operation fails (boolean).

Output

The output is a JSON object representing the updated canned response as returned by the Chatwoot API. It typically includes fields such as the canned response's ID, short code, content, timestamps, and other metadata.

If the update is successful, the output will contain the full updated canned response data under the json key.

If the operation deletes or modifies data successfully without returning the updated object, it returns a success confirmation JSON.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Chatwoot API via an API key credential configured in n8n.
  • The base URL for the Chatwoot instance must be set in the credentials.
  • The node uses HTTP PUT requests to update canned responses at the endpoint /api/v1/accounts/{accountId}/canned_responses/{cannedResponseId}.

Troubleshooting

  • Error: Unauthorized or 401 — Check that the API key credential is valid and has sufficient permissions.
  • Error: Not Found or 404 — Verify that the provided Account ID and Canned Response ID exist and are correct.
  • Error: Validation failed — Ensure that the short code and content values meet Chatwoot's requirements (e.g., non-empty if required).
  • Network errors/timeouts — Confirm network connectivity to the Chatwoot server and that the base URL is correctly configured.
  • If Continue on Fail is disabled, any error will stop execution; enable it to handle errors gracefully.

Links and References

Discussion