ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

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 retrieve contact information dynamically based on partial or full search queries, for example, when integrating customer data from ChatWoot into workflows for CRM updates, marketing campaigns, or support ticket enrichment.

Practical examples:

  • Searching for a contact by their email address to fetch their details before sending a personalized email.
  • Retrieving contacts sorted by last activity date to prioritize recent interactions.
  • Paging through large contact lists to process or analyze subsets of contacts incrementally.

Properties

Name Meaning
Account Id The numeric ID of the account to which the contacts belong. This is required for the search.
Q Search query string that can match contact name, identifier, email, or phone number.
Sort Attribute to sort the results by. Options: Name, Email, Phone Number, Last Activity At (each ascending or descending).
Page The page number of the results to retrieve, used for pagination.

Output

The node outputs JSON data representing the list of contacts matching the search criteria. Each item in the output typically contains contact details such as name, email, phone number, and other relevant attributes returned by the API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with 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

  • Common issues:

    • Invalid or missing account ID will cause the search to fail or return no results.
    • Incorrect API credentials or base URL configuration will result in authentication errors.
    • Using unsupported or misspelled sort options may lead to unexpected sorting behavior or errors.
    • Large result sets require proper handling of pagination via the page property.

  • Error messages:

    • Authentication failures usually indicate invalid API keys or misconfigured credentials.
    • "Account not found" or similar errors suggest the provided account ID does not exist or is inaccessible.
    • Network timeouts or connection errors imply connectivity issues with the ChatWoot API endpoint.

Links and References

Discussion