ChatWoot icon

ChatWoot

Consume ChatWoot API
Join our community

Actions11

Overview

The ChatWoot node for n8n allows you to interact with the ChatWoot API. Specifically, when using the Contact resource and the Get Contact Details operation, this node retrieves detailed information about a specific contact in your ChatWoot account. This is useful for automating workflows that require fetching user or customer details from ChatWoot, such as enriching CRM records, triggering follow-up actions based on contact data, or integrating ChatWoot contacts with other systems.

Example scenarios:

  • Automatically retrieving and syncing ChatWoot contact details into another database or CRM.
  • Fetching contact information to personalize automated messages or support tickets.
  • Using contact data to trigger conditional logic in multi-step workflows.

Properties

Name Type Meaning
Authentication options Selects the authentication method: either direct parameters or predefined credentials.
BaseUrl string The base URL of your ChatWoot instance (required if using parameter-based auth).
Access Token string The access token for ChatWoot API (required if using parameter-based auth).
Account ID string (Optional) The Account ID in ChatWoot; overrides credentials if provided.
Contact ID number The unique identifier of the contact whose details are to be retrieved.

Output

The output will be a JSON object containing the details of the requested contact. The structure typically includes fields such as:

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T15:30:00Z",
  // ...other contact-specific fields
}
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Key: You must provide a valid ChatWoot Access Token.
  • n8n Credentials: Optionally, you can use predefined ChatWoot credentials configured in n8n.
  • Environment Variables: None required by default, unless your n8n setup uses environment variables for credential management.

Troubleshooting

Common Issues:

  • Invalid Access Token: If the access token is incorrect or expired, authentication will fail.
  • Incorrect BaseUrl: Ensure the BaseUrl matches your ChatWoot instance.
  • Missing or Invalid Contact ID: If the Contact ID does not exist, the node will return an error.
  • Account ID Mismatch: Providing an incorrect Account ID may result in not finding the contact.

Error Messages:

  • "Authentication failed": Check your Access Token and BaseUrl.
  • "Contact not found": Verify the Contact ID and Account ID.
  • "Request failed with status code 404": Likely due to an invalid endpoint or missing resource.

How to resolve:

  • Double-check all input properties, especially authentication details and IDs.
  • Test your credentials using the built-in credential test feature in n8n.

Links and References

Discussion