ChatWoot

Overview

The ChatWoot node for n8n allows you to interact with the ChatWoot API. Specifically, when using the Contacts resource and the Contact Details operation, this node retrieves detailed information about a specific contact within a given ChatWoot account. This is useful in scenarios where you need to fetch and process contact data for automation workflows, such as syncing contact details with other systems, enriching CRM records, or triggering actions based on contact information.

Example use cases:

• Fetching a contact's details to personalize follow-up messages.
• Integrating ChatWoot contacts into your marketing automation tools.
• Validating contact existence before performing further operations.

Properties

Property Details

• Account Id: The unique numeric identifier for the ChatWoot account where the contact resides.
• Id: The unique identifier of the contact whose details you want to retrieve.

Output

The node outputs a json object containing the details of the specified contact. The structure typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T15:30:00Z",
  // ...other contact-specific fields
}

Note: The exact output fields depend on the ChatWoot API response for the contact details endpoint.

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure the chatwootApi credential in n8n, which should include:
  • Base URL of your ChatWoot instance (url)
  • API key or token with sufficient permissions to read contact details.

Troubleshooting

Common Issues:

• Invalid Account Id or Contact Id: If either ID is incorrect or does not exist, the node may return an error or an empty result.
• Authentication Errors: If the API credentials are missing or invalid, you may see errors related to authentication (e.g., "401 Unauthorized").
• Network/Connection Issues: If n8n cannot reach your ChatWoot instance (wrong URL, network issues), requests will fail.

Error Messages & Resolutions:

• "401 Unauthorized": Check that your API credentials are correct and have permission to access the contact.
• "404 Not Found": Ensure both the Account Id and Contact Id are valid and exist in your ChatWoot instance.
• "Connection refused" or similar: Verify the base URL and network connectivity between n8n and ChatWoot.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Credentials
• n8n Community Forum