ChatWoot

Overview

This node allows you to create a new message within an existing conversation in ChatWoot, a customer engagement platform. It is useful for automating the process of sending messages (such as replies, notes, or notifications) to customers or team members directly from n8n workflows. Typical scenarios include responding to customer inquiries, adding internal notes, or sending templated WhatsApp messages.

Example use cases:

• Automatically reply to a customer when a support ticket is updated.
• Add a private note to a conversation after a workflow action.
• Send a WhatsApp template message to a user based on workflow triggers.

Properties

Below are the input properties supported by this operation:

Output

The node returns the response from the ChatWoot API after creating the message. The output will be available in the json field and typically includes details about the created message, such as:

{
  "id": 12345,
  "content": "Your message text",
  "message_type": "outgoing",
  "private": true,
  "content_type": "cards",
  "content_attributes": { /* ... */ },
  "template_params": { /* ... */ },
  // ...other fields returned by ChatWoot API
}

Note: The exact structure may vary depending on the ChatWoot API version and the provided input.

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) and authentication details.
• n8n Configuration: No additional configuration required beyond credentials.

Troubleshooting

Common Issues:

• Invalid Account or Conversation ID: Ensure that both IDs exist and are correct in your ChatWoot instance.
• Authentication Errors: If credentials are missing or incorrect, the node will fail to connect to ChatWoot.
• Malformed JSON: For properties like "Content Attributes" or "Template Params", ensure valid JSON is provided.
• Missing Required Fields: All required fields (Account Id, Conversation Id, Content) must be filled; otherwise, the node will throw validation errors.

Error Messages & Resolutions:

• "401 Unauthorized": Check your API credentials and permissions.
• "404 Not Found": Verify the Account Id and Conversation Id.
• "400 Bad Request": Review your input data, especially JSON fields for syntax errors.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Creating Custom Nodes
• ChatWoot Website