ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node interacts with the ChatWoot API to retrieve detailed information about a specific contact. It is particularly useful in workflows where you need to fetch and process contact details based on identifiers obtained from previous steps, such as after creating or listing contacts. For example, you might use this node to enrich CRM records, trigger follow-up actions, or synchronize contact data between systems.

Properties

Display Name Type Description
Inbox Identifier String The identifier obtained from API inbox channel. Required.
Contact Identifier String The source id of contact obtained on contact create. Required.

Both properties are mandatory and must be provided to successfully retrieve contact details.

Output

The output will be a JSON object containing the details of the requested contact. The structure of the output depends on the ChatWoot API's response for the "Get Details Of A Contact" operation. Typically, it includes fields such as:

{
  "id": "string",
  "name": "string",
  "email": "string",
  "phone_number": "string",
  "created_at": "timestamp",
  "updated_at": "timestamp",
  // ...other contact-specific fields
}

No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: You must configure n8n credentials named chatwootApi, which should include at least the base URL (url) and any required authentication tokens.
  • n8n Configuration: Ensure that the ChatWoot node is properly installed and that your n8n instance can reach the ChatWoot API endpoint.

Troubleshooting

Common Issues:

  • Missing or Invalid Identifiers: If either the Inbox Identifier or Contact Identifier is missing or incorrect, the node will fail to retrieve contact details.
  • Authentication Errors: Incorrect or expired API credentials will result in authentication errors.
  • Network Issues: Connectivity problems between n8n and the ChatWoot API endpoint may cause timeouts or connection failures.

Error Messages and Resolutions:

  • "404 Not Found": The specified contact does not exist. Double-check the Contact Identifier.
  • "401 Unauthorized": Check your API credentials in n8n.
  • "400 Bad Request": One or more required parameters are missing or malformed.

Links and References

Discussion