ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the Messages API of ChatWoot to create and send a new message within an existing conversation. It is useful in scenarios where automated messaging or chatbot interactions are required, such as sending notifications, customer support replies, or follow-up messages in a conversation thread.

For example, you can use this node to:

  • Automatically send a welcome message when a new contact starts a conversation.
  • Post updates or alerts to a specific conversation based on external triggers.
  • Implement chatbots that respond dynamically by creating messages in ongoing conversations.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where the message will be sent.
Contact Identifier The source ID of the contact who is the sender or recipient of the message.
Conversation Id The numeric ID representing the specific conversation thread to which the message belongs.
Content The textual content/body of the message to be created and sent.
Echo Id A temporary identifier used for tracking the message via websockets (optional).

Output

The node outputs JSON data representing the response from the Messages API after creating the message. This typically includes details about the newly created message such as its ID, timestamps, status, and any metadata returned by the API.

If the API supports binary data (e.g., attachments), the node would handle it accordingly, but based on the provided properties and code, the output focuses on JSON message data only.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • Depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.
  • The node uses the OpenAPI specification defined in openapi.json to build its properties and requests.

Troubleshooting

  • Missing Required Fields: Ensure that Inbox Identifier, Contact Identifier, and Conversation Id are provided; otherwise, the API call will fail.
  • Invalid Identifiers: Using incorrect or outdated IDs may result in errors like "Conversation not found" or "Contact does not exist."
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Check connectivity to the ChatWoot server URL configured in credentials.
  • Empty Content: Sending a message without content might be rejected by the API; always provide meaningful text.

Links and References

Discussion