ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the Messages API of a messaging platform to create and send new messages within existing conversations. It is useful for automating message sending workflows, such as responding to customer inquiries, sending notifications, or triggering follow-up messages based on events.

Typical use cases include:

  • Sending automated replies in customer support chat systems.
  • Posting updates or alerts into ongoing conversations.
  • Integrating external systems to push messages into chat threads programmatically.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where the message will be sent.
Contact Identifier The unique 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, this node primarily deals with text content.

Dependencies

  • Requires an API key credential for authenticating with the messaging platform's API.
  • Needs the base URL of the messaging service configured in the credentials.
  • Depends on the @devlikeapro/n8n-openapi-node package for building request properties from the OpenAPI specification.
  • The node uses the OpenAPI definition (openapi.json) bundled with the source to define its operations and parameters.

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 valid and has sufficient permissions.
  • Network Issues: Check connectivity to the messaging platform's API endpoint.
  • Echo Id Misuse: If using Echo Id for websocket tracking, ensure it is unique per message to avoid confusion.

Common error messages might include HTTP 400 for bad requests due to missing or invalid parameters, or HTTP 401/403 for authentication issues.

Links and References

Discussion