Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node operation updates custom attributes of a specific conversation in Chatwoot. Custom attributes are user-defined key-value pairs that can be attached to conversations to store additional metadata or information relevant to the business context.

Typical use cases include:

  • Tagging conversations with priority levels (e.g., "priority": "high").
  • Adding internal notes or flags for follow-up.
  • Storing customer-specific data like subscription status or campaign source.

For example, you might update a conversation's custom attribute "priority" to "high" when it requires urgent attention, enabling automated workflows or reporting based on this attribute.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account under which the conversation exists.
Conversation ID The numeric ID of the conversation whose custom attributes you want to update.
Custom Attributes One or more key-value pairs representing the custom attributes to set on the conversation. Each attribute has:
- Key: The name of the custom attribute (e.g., "priority").
- Value: The value to assign to that key (e.g., "high").
Continue on Fail Whether to continue executing subsequent items if this operation fails (boolean).

Output

The output is a JSON object representing the updated conversation resource returned by the Chatwoot API after successfully updating its custom attributes. It contains all standard conversation fields along with the newly updated custom attributes.

If multiple input items are processed, the output is an array of such JSON objects, one per item.

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the Chatwoot API via an API key credential configured in n8n.
  • The node uses the Chatwoot REST API endpoint:
    PUT /api/v1/accounts/{accountId}/conversations/{conversationId}/custom_attributes
  • The base URL for the API must be set in the credentials configuration.

Troubleshooting

  • Invalid Account or Conversation ID: If the provided IDs do not exist or are incorrect, the API will return an error. Verify the IDs before running the node.
  • Missing Required Parameters: Both Account ID and Conversation ID are required. Omitting them will cause the node to fail.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update conversations.
  • Malformed Custom Attributes: Keys and values should be strings. Providing invalid types may cause errors.
  • Continue on Fail: If enabled, the node will not stop execution on errors but will output error messages in the JSON field for failed items.

Links and References

Discussion