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" operation for the "Contact" resource retrieves detailed information about a single contact by its numeric ID within a given account.

Typical use cases include:

  • Fetching contact details to display or process in workflows.
  • Integrating Chatwoot contact data into other systems or automations.
  • Validating contact existence before performing updates or deletions.

For example, you might use this node to retrieve a contact's email and phone number based on their ID to personalize customer communications or to sync contact data with a CRM.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account under which the contact exists.
Contact ID The numeric ID of the specific contact to retrieve.
Continue on Fail Whether the node should continue executing subsequent items if this operation fails.

Output

The output is a JSON object representing the full details of the requested contact as returned by the Chatwoot API. This includes all standard contact fields such as name, email, phone number, identifier, avatar URL, blocked status, custom attributes, and any additional attributes associated with the contact.

Example output structure (simplified):

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "identifier": "unique_id_123",
  "avatar_url": "https://example.com/avatar.jpg",
  "blocked": false,
  "custom_attributes": {
    "company": "Acme Corp"
  },
  "additional_attributes": {
    "city": "San Francisco"
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Chatwoot API.
  • The base URL of the Chatwoot instance must be set in the credentials.
  • Network access to the Chatwoot API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID or Contact ID will cause the API request to fail.
    • Incorrect API credentials or base URL configuration will result in authentication errors.
    • If the contact does not exist, the API may return a 404 error.

  • Error messages:

    • "404 Not Found": The specified contact ID does not exist in the given account. Verify the IDs.
    • "401 Unauthorized" or "403 Forbidden": Authentication failed. Check API key and permissions.
    • Network timeouts or connection errors: Ensure the Chatwoot server is reachable from n8n.

  • Resolution tips:

    • Double-check that the Account ID and Contact ID are correct and correspond to existing entities.
    • Confirm that the API key credential is valid and has sufficient permissions.
    • Enable "Continue on Fail" if you want the workflow to proceed despite individual item failures.

Links and References

Discussion