Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node interacts with the Chatwoot API to manage contacts within a specified account. The "Get Many" operation for the "Contact" resource retrieves multiple contact records associated with an account. It supports sorting the results by various attributes such as name, email, phone number, or last activity date.

Typical use cases include:

  • Fetching all contacts from a Chatwoot account to synchronize with another system.
  • Retrieving a sorted list of contacts for reporting or analysis.
  • Integrating contact data into workflows that require bulk processing or filtering.

For example, you might use this node to get all contacts sorted by their last activity date to prioritize outreach efforts.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account from which to retrieve contacts (required).
Sort By Attribute to sort the results by. Options: Email (A-Z), Email (Z-A), Last Activity (Newest), Last Activity (Oldest), Name (A-Z), Name (Z-A), Phone Number (A-Z), Phone Number (Z-A). Default is Name (A-Z).
Continue on Fail Whether to continue execution if the operation fails (boolean).

Output

The output is an array of JSON objects, each representing a contact retrieved from the Chatwoot account. Each contact object contains all standard contact fields as returned by the Chatwoot API, such as:

  • id: Contact identifier
  • name: Contact's full name
  • email: Email address
  • phone_number: Phone number
  • identifier: Unique identifier string
  • Other metadata and custom attributes as defined in Chatwoot

The output does not include binary data.

Dependencies

  • Requires an active connection to the Chatwoot API via an API key credential.
  • The node uses the base URL configured in the credentials to make HTTP requests.
  • Proper permissions on the Chatwoot account are necessary to read contact data.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the API request to fail.
    • Network connectivity problems can prevent successful API calls.
    • Insufficient permissions on the API key may result in authorization errors.

  • Error messages:

    • "Request failed with status code 404": The specified account or endpoint was not found. Verify the Account ID.
    • "Request failed with status code 401": Unauthorized access. Check the API key credentials.
    • "Request failed with status code 400": Bad request, possibly due to invalid parameters like unsupported sort options.

  • Resolution tips:

    • Ensure the Account ID is correct and exists in Chatwoot.
    • Confirm the API key has read access to contacts.
    • Validate network connectivity and proxy settings if applicable.
    • Use the "Continue on Fail" option to handle errors gracefully in workflows.

Links and References

Discussion