ChatWoot

Overview

The ChatWoot - Conversation List node allows you to retrieve a list of conversations from your ChatWoot account. This is useful for automating workflows that need to process, filter, or analyze customer conversations, such as generating reports, monitoring support activity, or integrating with other systems for follow-up actions.

Practical examples:

• Fetch all open conversations assigned to a specific team for daily review.
• Search for conversations containing a particular keyword for sentiment analysis.
• Retrieve unresolved conversations in a specific inbox for escalation.

Properties

Below are the supported input properties for the "Conversation List" operation:

Output

The output will be a collection of conversation objects in the json field. Each object typically contains details such as:

{
  "id": 12345,
  "status": "open",
  "assignee_id": 6789,
  "inbox_id": 1,
  "team_id": 2,
  "labels": ["priority", "vip"],
  "messages": [
    {
      "content": "Hello, how can I help you?",
      "created_at": "2024-06-01T12:00:00Z"
    }
  ],
  ...
}

Note: The exact structure may vary depending on the ChatWoot API version and configuration.

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure the chatwootApi credential in n8n, including the base URL and authentication token.
• n8n Configuration: No additional environment variables are required beyond standard credential setup.

Troubleshooting

Common Issues:

• Invalid Credentials: If the API key or URL is incorrect, you may receive authentication errors. Double-check your credentials in n8n.
• Missing Required Fields: The "Account Id" property is required. Omitting it will result in an error.
• API Rate Limits: Excessive requests may trigger rate limiting by ChatWoot. Monitor your usage if you encounter 429 errors.
• Incorrect Property Types: Ensure that fields like "Labels" are provided in the correct format (e.g., as a JSON array).

Error Messages:

• "401 Unauthorized": Check your API credentials.
• "400 Bad Request": Verify that all required fields are filled and formatted correctly.
• "404 Not Found": Ensure the Account Id, Inbox Id, or Team Id exist in your ChatWoot instance.

Links and References

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