ChatWoot icon

ChatWoot

Consume ChatWoot API
Join our community

Actions11

Overview

This n8n node allows you to interact with the ChatWoot API, specifically to create a new public message within a conversation. It is useful for automating the sending of messages to ChatWoot conversations from workflows, such as notifying users, updating tickets, or integrating with other systems.

Example scenarios:

  • Automatically send a welcome message when a new contact is created.
  • Post updates to a conversation based on events in other systems (e.g., CRM, support tools).
  • Integrate ChatWoot messaging into multi-step automation flows.

Properties

Name Type Meaning
Authentication options Selects the authentication method: either direct parameters or predefined credentials.
BaseUrl string The base URL of your ChatWoot instance (required if using parameter-based auth).
Source ID string Internal source contact identifier; used for search and must be URL-escaped or HEX.
Inbox Identifier string Identifier for the inbox where the message will be sent.
Conversation ID string The ID of the conversation to which the message will be added.
Content string The text content of the message to be created.

Output

The node outputs a JSON object representing the result of the "Create Message" operation. The structure typically includes details about the created message, such as its ID, content, timestamps, sender information, and any relevant metadata returned by the ChatWoot API.

Example output:

{
  "id": 12345,
  "content": "Hello, this is an automated message.",
  "conversation_id": "67890",
  "inbox_id": "abcde",
  "created_at": "2024-06-01T12:34:56Z",
  "sender": {
    "id": "user_1",
    "name": "Bot"
  },
  ...
}

Note: The exact fields depend on the ChatWoot API response.

Dependencies

  • ChatWoot Instance: You need access to a running ChatWoot server.
  • API Credentials: Either provide the BaseUrl and Access Token directly, or use predefined ChatWoot credentials configured in n8n.
  • n8n Configuration: If using predefined credentials, ensure they are set up in n8n's credential store.

Troubleshooting

  • Authentication Errors:
    • Error message: "Authentication failed" or similar.
      Resolution: Check that your BaseUrl and Access Token are correct, or verify your predefined credentials in n8n.
  • Invalid IDs:
    • Error message: "Conversation not found" or "Inbox not found".
      Resolution: Ensure that the provided Conversation ID and Inbox Identifier exist in your ChatWoot instance.
  • Missing Required Fields:
    • Error message: "Required parameter missing".
      Resolution: Make sure all required properties (BaseUrl, Inbox Identifier, Conversation ID, Content) are filled in.

Links and References

Discussion