ChatWootInstall

Overview

This node allows you to search for contacts within a specified account using various criteria such as name, identifier, email, or phone number. It is useful in scenarios where you need to quickly find contact details from a large list, filter contacts based on specific attributes, or integrate contact search functionality into automated workflows.

Practical examples include:

• Searching for a customer by email before sending a targeted marketing campaign.
• Retrieving contact information by phone number to verify user identity.
• Sorting contacts by last activity date to prioritize recent interactions.

Properties

Output

The node outputs JSON data containing the search results for contacts matching the query parameters. The structure typically includes an array of contact objects with their details such as name, email, phone number, and other relevant fields returned by the API.

If binary data were involved (e.g., contact avatars), it would be included separately, but this node focuses on JSON contact data only.

Dependencies

• Requires an API key credential to authenticate requests against the ChatWoot API.
• Needs the base URL of the ChatWoot instance configured in credentials.
• Depends on the ChatWoot REST API being accessible and responsive.

Troubleshooting

• Missing or invalid Account Id: Ensure the Account Id is provided and is a valid numeric value; otherwise, the API will reject the request.
• Empty or incorrect search query (Q): If no results are returned, verify the search string matches existing contact data.
• API authentication errors: Check that the API key credential is correctly set up and has sufficient permissions.
• Pagination issues: If requesting pages beyond available data, the response may be empty; adjust the page number accordingly.
• Sorting errors: Use only the supported sort options; invalid values might cause the API to ignore the parameter or return errors.

Links and References

• ChatWoot API Documentation
• n8n Documentation - Creating Custom Nodes
• REST API Pagination Best Practices