ChatWoot icon

ChatWoot

Interact with ChatWoot API

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 matches, for example, when integrating customer data from ChatWoot into workflows for marketing, support, or CRM synchronization.

Practical examples:

  • Searching for a contact by email to fetch their details before sending a personalized message.
  • Retrieving a paginated list of contacts sorted by last activity date to prioritize outreach.
  • Filtering contacts by phone number to verify if a user exists in the system.

Properties

Name Meaning
Account Id The numeric ID of the account to which the contacts belong. This is required to scope the search.
Q A search query string that can match contact name, identifier, email, or phone number.
Sort Attribute to sort the results by. Options include: Name, Email, Phone Number, Last Activity At. Each can be ascending or descending (prefixed with -).
Page The page number of the results to retrieve, supporting pagination through the contact list.

Output

The node outputs JSON data representing the search results of contacts matching the query parameters. The structure typically includes an array of contact objects with their attributes such as name, email, phone number, and activity timestamps. There is no indication of binary data output.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the credentials.
  • The node uses HTTP requests to interact with the ChatWoot REST API endpoints.

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 malformed search query (q): If the query string is empty or improperly formatted, the search may return no results or an error.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Pagination issues: Requesting pages beyond the available range may result in empty responses.
  • Sorting errors: Using unsupported sort values could cause the API to ignore the parameter or return errors.

Links and References

Discussion