ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The ChatWoot node for n8n allows you to interact with the ChatWoot API. Specifically, the Contacts → Contact List operation retrieves a paginated and sortable list of contacts associated with a given account in your ChatWoot workspace. This is useful for automating workflows that need to fetch, process, or synchronize contact data from ChatWoot, such as generating reports, syncing with CRMs, or triggering actions based on contact lists.

Example scenarios:

  • Fetching all contacts for a specific account to send targeted emails.
  • Syncing ChatWoot contacts with another system (e.g., CRM, marketing platform).
  • Listing contacts sorted by last activity to prioritize follow-ups.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account whose contacts you want to list. (Required)
Sort Options The attribute by which the contact list should be sorted. Options include:
- Name
- Email
- Phone Number
- Last Activity At
Each can be sorted ascending (e.g., "Name") or descending (e.g., "-Name").
Page Number The page number for pagination. Default is 1.

Output

The node outputs a JSON array where each item represents a contact from the ChatWoot account. Each contact object typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "last_activity_at": "2024-06-01T12:34:56Z",
  // ...other contact fields as provided by the ChatWoot API
}
  • The exact structure depends on the ChatWoot API's response for the contact listing endpoint.
  • No binary output is produced by this operation.

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: You must configure chatwootApi credentials in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure the ChatWoot node is installed and properly configured in your n8n environment.

Troubleshooting

Common Issues:

  • Invalid Account Id: If the provided Account Id does not exist or is incorrect, the node may return an error or an empty list.
  • Authentication Errors: Missing or invalid API credentials will result in authentication failures.
  • Pagination Issues: Requesting a page number beyond the available range will return an empty list.
  • Sorting Errors: Providing an unsupported sort value may cause the API to default to a standard sorting or return an error.

Error Messages & Resolutions:

  • "401 Unauthorized": Check your API credentials and ensure they are correct.
  • "404 Not Found": Verify the Account Id exists in your ChatWoot instance.
  • "400 Bad Request": Ensure all required properties are set and valid, especially the Account Id and sort options.

Links and References

Discussion