Chatwoot icon

Chatwoot

Interact with Chatwoot API
Join our community

Actions36

Overview

This node integrates with the Chatwoot API to manage contacts and other resources within a Chatwoot account. Specifically, the Contact - Get operation retrieves detailed information about a single contact by its numeric ID. This is useful in scenarios where you want to fetch up-to-date contact details from Chatwoot for further processing, reporting, or integration with other systems.

Practical examples:

  • Fetching a contact's profile before sending a personalized message.
  • Retrieving contact data to synchronize with a CRM system.
  • Using contact details to trigger conditional workflows based on attributes like email or phone number.

Properties

Name Meaning
Contact ID The unique numeric identifier of the contact to retrieve.
Continue on Fail Whether the node should continue processing subsequent items if this operation fails.
Debug Logging Enables detailed logging of HTTP requests and internal steps to the console for debugging.

Output

The output contains the JSON response from the Chatwoot API representing the requested contact. The structure typically includes all available contact fields such as name, email, phone number, custom attributes, labels, avatar URL, blocked status, inbox association, and any additional attributes defined in Chatwoot.

Example output JSON (simplified):

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "phone_number": "+1234567890",
  "avatar_url": "https://example.com/avatar.jpg",
  "blocked": false,
  "inbox_id": 1,
  "custom_attributes": {
    "user_type": "premium"
  },
  "additional_attributes": {
    "city": "San Francisco"
  }
}

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • The node expects the Chatwoot account ID and base URL to be configured in the credentials.
  • Network access to the Chatwoot instance's API endpoint is necessary.

Troubleshooting

  • Invalid Contact ID: If the provided contact ID does not exist, the API will return an error. Ensure the ID is correct and the contact exists.
  • Authentication Errors: Missing or invalid API token will cause authentication failures. Verify that the API key credential is correctly set up.
  • JSON Parsing Errors: Not applicable for this operation since it only performs a GET request without user-provided JSON.
  • Network Issues: Timeouts or unreachable host errors indicate connectivity problems to the Chatwoot server.
  • Debug Logging: Enable debug logging to see detailed request URLs, headers, and responses in the console, which helps diagnose issues.

Links and References

This summary focuses exclusively on the Contact - Get operation as requested, describing its input parameters, output, and behavior based on static analysis of the source code.

Discussion