ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The Get Inbox Members operation for the Inboxes resource in this custom n8n node allows you to retrieve a list of members associated with a specific inbox within a ChatWoot account. This is useful for automating workflows that need to access or process information about who has access to particular inboxes, such as managing team assignments, auditing permissions, or integrating with other systems for user management.

Practical examples:

  • Automatically syncing inbox member lists with external HR or directory systems.
  • Generating reports on which users have access to certain communication channels.
  • Triggering notifications or actions when inbox membership changes.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account. (Required)
Inbox Id Number The ID of the Inbox. (Required)

Both properties are required and must be provided to fetch the members of a specific inbox.

Output

The output will be a JSON object containing details about the members of the specified inbox. While the exact structure depends on the ChatWoot API, typical fields may include:

{
  "id": 123,
  "name": "Jane Doe",
  "email": "jane@example.com",
  "role": "agent",
  // ...other member-specific fields
}

The node outputs an array of such objects, each representing a member of the inbox.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure the node is properly authenticated and the ChatWoot API is reachable from your n8n environment.

Troubleshooting

Common issues:

  • Invalid Account Id or Inbox Id: If either ID is incorrect or does not exist, the node may return an error or an empty result.
  • Authentication Errors: Missing or invalid API credentials will prevent the node from accessing the ChatWoot API.
  • Network Issues: If n8n cannot reach the ChatWoot server (e.g., due to firewall or DNS problems), requests will fail.

Common error messages:

  • "401 Unauthorized": Check your API credentials and ensure they are correct.
  • "404 Not Found": Verify that the provided Account Id and Inbox Id are valid and exist in your ChatWoot instance.
  • "Connection refused" or timeout errors: Ensure network connectivity between n8n and ChatWoot.

Links and References

Discussion