ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to interact with the ChatWoot API, specifically to retrieve conversations associated with a particular contact. It is useful in scenarios where you need to fetch all conversations for a given contact within a specific ChatWoot account. For example, you might use this node to automate customer support workflows, analyze communication history, or trigger follow-up actions based on conversation data.

Practical Example:

  • Automatically gather all conversations for a customer when their contact ID is known, and process or analyze these conversations further in your n8n workflow.

Properties

Display Name Type Required Description
Account Id Number Yes The numeric ID of the ChatWoot account. This identifies which account's contacts are being queried.
Id Number Yes ID of the contact. This specifies which contact's conversations will be retrieved.

Output

The output will be a JSON object (or array of objects) representing the conversations associated with the specified contact. Each object typically contains details about an individual conversation, such as:

{
  "id": 12345,
  "inbox_id": 678,
  "contact_id": 23456,
  "status": "open",
  "assignee_id": 789,
  "messages": [
    {
      "id": 1,
      "content": "Hello!",
      "created_at": "2023-01-01T12:00:00Z"
    }
    // ...more messages
  ],
  // ...other conversation fields
}

Note: The exact structure may vary depending on the ChatWoot API response schema.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure chatwootApi credentials in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure that the ChatWoot node is properly installed and configured in your n8n environment.

Troubleshooting

  • Missing or Invalid Credentials:
    If the node fails due to authentication errors, verify that your chatwootApi credentials are correctly set up in n8n.
  • Invalid Account Id or Contact Id:
    Supplying incorrect IDs may result in "Not Found" or similar errors from the API. Double-check that both the Account Id and Contact Id exist in your ChatWoot instance.
  • Network/Connection Issues:
    Errors related to network connectivity or unreachable endpoints indicate issues with the provided base URL or network configuration.

Links and References

Discussion