ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve information about contactable inboxes associated with a specific contact. It is useful in scenarios where you need to fetch all inboxes through which a particular contact can be reached within an account, such as for customer support or communication management purposes.

For example, if you want to list all channels (email, social media, chat widgets) where a customer can be contacted, this node operation will provide that data by specifying the account and contact IDs.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account to which the contact belongs.
Id The numeric ID of the contact whose contactable inboxes you want to retrieve.

Output

The output JSON contains details about the contactable inboxes linked to the specified contact. This typically includes identifiers and metadata for each inbox through which the contact can be reached. The exact structure depends on the ChatWoot API response but generally provides an array of inbox objects.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Uses the ChatWoot REST API endpoint related to contacts and their inboxes.

Troubleshooting

  • Invalid Account or Contact ID: If the provided account or contact ID does not exist or is incorrect, the API will return an error. Verify the IDs before running the node.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access contact data.
  • Network Issues: Connectivity problems with the ChatWoot server may cause timeouts or failures. Check network settings and ChatWoot server status.
  • API Changes: If the ChatWoot API changes, the node might fail. Keep the node and its dependencies updated.

Links and References

Discussion