ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the ChatWoot API to create a new inbox within a specified account. It is useful for automating the setup of communication channels in ChatWoot, such as when onboarding new clients or organizing conversations by different teams or purposes. For example, a user can programmatically create an inbox named "Support" with a custom avatar and channel configuration, streamlining the management of customer support workflows.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the inbox will be created.
Name The display name of the inbox to be created.
Avatar A file path or URL representing the avatar image for the inbox.
Channel JSON object defining the channel configuration associated with the inbox (e.g., type).

Output

The node outputs JSON data representing the newly created inbox object returned from the ChatWoot API. This typically includes details such as the inbox ID, name, avatar URL, channel settings, creation timestamps, and other metadata. 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

  • Common issues:
    • Invalid or missing account ID may cause the API to reject the request.
    • Incorrectly formatted JSON in the Channel property can lead to parsing errors.
    • Missing or invalid API authentication token will result in authorization failures.
  • Error messages:
    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set.
    • "Invalid input": Verify that all required properties are provided and properly formatted.
    • "Account not found": Confirm the account ID exists in the ChatWoot system.

Links and References

Discussion