ChatWoot

Overview

This n8n node interacts with the ChatWoot Messages API to list all messages in a specific conversation. It is designed for scenarios where you need to retrieve the full message history of a conversation between a contact and an inbox within ChatWoot. This can be useful for:

• Archiving or analyzing customer support conversations.
• Integrating ChatWoot data into other systems (e.g., CRMs, reporting tools).
• Triggering workflows based on conversation content.

Example use case:
A support manager wants to automatically export all messages from a particular conversation for sentiment analysis or compliance archiving.

Properties

All properties are required for this operation.

Output

The node outputs a JSON array where each item represents a message from the specified conversation. Each message object typically includes fields such as:

{
  "id": 12345,
  "content": "Hello, how can I help you?",
  "created_at": "2024-06-01T12:34:56Z",
  "sender": {
    "id": 6789,
    "name": "Support Agent"
  },
  // ...other message metadata
}

• The exact structure may include additional metadata depending on the ChatWoot API response.
• No binary output is produced by this operation.

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure chatwootApi credentials in n8n, including the base URL (url) and authentication details.
• n8n Configuration: Ensure the node has access to the required credentials and that your n8n instance can reach the ChatWoot API endpoint.

Troubleshooting

Common Issues:

• Invalid Credentials:
  Error if the provided API key or URL is incorrect.
  Resolution: Double-check your ChatWoot API credentials in n8n.

• Missing or Incorrect Identifiers:
  If any of the required identifiers (Inbox, Contact, Conversation) are missing or invalid, the API will likely return a 404 or similar error.
  Resolution: Ensure you are using valid IDs as returned by ChatWoot when creating inboxes, contacts, or conversations.

• Network/Connection Errors:
  If n8n cannot reach the ChatWoot API (due to firewall, DNS, etc.), requests will fail.
  Resolution: Verify network connectivity and API availability.

Error Messages:

• "401 Unauthorized": Check your API key and permissions.
• "404 Not Found": One of the identifiers does not exist.
• "400 Bad Request": Input parameters are malformed or missing.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Creating Credentials
• n8n Community Support