ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node allows you to create a new message within an existing conversation in a ChatWoot account. It is useful for automating communication workflows, such as sending outgoing messages or notes to customers, logging incoming messages, or posting templated content programmatically.

Common scenarios include:

  • Automatically replying to customer inquiries with predefined messages.
  • Adding private notes to conversations for internal use.
  • Sending rich content like cards, forms, or articles within conversations.
  • Using template parameters to send localized or customized WhatsApp messages.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the conversation exists.
Conversation Id The numeric ID of the conversation to which the message will be added.
Content The textual content of the message to send.
Message Type Specifies if the message is "Outgoing" (sent by agent) or "Incoming" (received from customer).
Private Boolean flag indicating if the message is a private note (true) or visible to the customer (false).
Content Type The type of message content; options include: Input Email, Cards, Input Select, Form, Article.
Content Attributes JSON object containing additional attributes specific to the chosen content type.
Template Params JSON object defining template parameters used for templated messages, e.g., in WhatsApp channel.

Output

The node outputs JSON data representing the created message object returned by the ChatWoot API. This typically includes details such as message ID, content, timestamps, sender information, and status.

If binary data were supported (not indicated here), it would represent attachments or media related to the message, but this node focuses on JSON message creation only.

Dependencies

  • Requires an active ChatWoot account and access credentials (API key/token).
  • Needs the base URL of the ChatWoot instance configured in the node credentials.
  • Depends on the ChatWoot REST API to create messages within conversations.

Troubleshooting

  • Invalid Account or Conversation ID: Ensure that the provided numeric IDs correspond to existing entities in your ChatWoot account.
  • Authentication Errors: Verify that the API key/token and base URL are correctly set in the node credentials.
  • Malformed JSON in Content Attributes or Template Params: Make sure JSON inputs are valid and properly formatted.
  • Unsupported Content Type: Use one of the allowed content types; otherwise, the API may reject the request.
  • Private Flag Misuse: Setting private incorrectly might cause messages to be visible or hidden unexpectedly.

Links and References

Discussion