ChatWoot

Overview

The Contact Search operation in the Contacts resource allows you to search for contacts within a specified account using various criteria such as name, identifier, email, or phone number. This node is useful when you need to retrieve and filter contact information from your ChatWoot instance, for example:

• Finding a contact by their email address or phone number.
• Listing all contacts that match a specific search term.
• Paginating through large sets of contacts with sorting options.

Practical examples:

• Automate lead lookups by searching for contacts based on incoming data.
• Build workflows that trigger actions when a contact matching certain criteria is found.

Properties

Output

The output will be a JSON object containing the list of contacts that match the search criteria. Each item in the output array represents a contact and typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "identifier": "unique-id",
  "last_activity_at": "2024-06-01T12:34:56Z",
  // ...other contact fields
}

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

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Key/Credentials: You must configure n8n credentials named chatwootApi with the appropriate API key and base URL (url).
• n8n Configuration: Ensure the node has access to the internet and can reach your ChatWoot server.

Troubleshooting

Common Issues:

• Invalid Credentials: If the API key or URL is incorrect, authentication errors will occur. Double-check your chatwootApi credentials in n8n.
• Missing Required Fields: The Account Id property is required. Omitting it will result in an error.
• No Results Found: If the search query does not match any contacts, the output will be an empty array.
• Pagination Issues: If the Page value exceeds available pages, the output may be empty.

Error Messages:

• "401 Unauthorized": Check your API key and permissions.
• "404 Not Found": Verify the account ID and endpoint URL.
• "400 Bad Request": Ensure all required parameters are provided and valid.

Links and References

• ChatWoot API Documentation – Contacts
• n8n Documentation – Custom Nodes
• ChatWoot Official Website