ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve members of a specific inbox within an account. It is useful for scenarios where you need to programmatically access and manage the list of users or agents assigned to handle conversations in a particular inbox. For example, a support team lead might use this node to fetch all members of a customer support inbox to audit assignments or synchronize user data with another system.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account that owns the inbox.
Inbox Id The numeric ID of the specific inbox whose members you want to retrieve.

Output

The node outputs JSON data representing the members of the specified inbox. This typically includes details such as member IDs, names, roles, and other relevant metadata about each inbox member. The output structure aligns with the ChatWoot API response for inbox members.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials configuration.

Troubleshooting

  • Common Issues:

    • Invalid or missing Account Id or Inbox Id will cause the API request to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Network connectivity issues can prevent successful communication with the ChatWoot server.
  • Error Messages:

    • 401 Unauthorized: Check that the API key/token is correctly configured and has not expired.
    • 404 Not Found: Verify that the Account Id and Inbox Id are correct and exist in the ChatWoot instance.
    • 400 Bad Request: Ensure that the input parameters are valid numbers and properly formatted.

Resolving these usually involves verifying credentials, confirming resource IDs, and ensuring network access.

Links and References

Discussion