ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

The node interacts with the ChatWoot API to update the list of agents assigned to a specific inbox within an account. This operation is useful for managing team members who can access and respond to conversations in that inbox. For example, a support manager might use this node to add or remove agents from an inbox when team responsibilities change.

Properties

Name Meaning
Account Id The numeric ID of the account to which the inbox belongs.
Inbox Id The unique identifier of the inbox where agents will be updated.
User Ids A JSON array containing the IDs of users (agents) to be added to the inbox.

Output

The node outputs JSON data representing the result of the update operation on the inbox agents. This typically includes confirmation of the updated agent list or details about the inbox after modification. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account or Inbox ID: If the provided account or inbox ID does not exist or is incorrect, the API will likely return an error. Verify these IDs before running the node.
  • Malformed User IDs JSON: The User Ids property expects a valid JSON array. Invalid JSON syntax will cause parsing errors. Ensure the input is correctly formatted.
  • Authentication Errors: Missing or invalid API credentials will prevent the node from connecting to the ChatWoot API. Confirm that the API key and base URL are correctly set.
  • Permission Issues: The API user associated with the credentials must have permission to modify inbox agents. Lack of permissions will result in authorization errors.

Links and References

Discussion