ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the Messages API of a messaging platform to update an existing message within a conversation. It is useful in scenarios where you need to programmatically modify the content or metadata of a previously sent message, such as correcting typos, updating information, or appending additional details.

Practical examples include:

  • Editing customer support messages after receiving new information.
  • Updating automated notification messages based on user actions.
  • Modifying chat logs for compliance or audit purposes.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where the message resides.
Contact Identifier The source ID of the contact associated with the message, obtained when the contact was created.
Conversation Id The numeric ID representing the specific conversation containing the message.
Message Id The numeric ID of the message that needs to be updated.
Submitted Values A JSON object containing the fields and values to update in the message.

Output

The node outputs JSON data representing the response from the Messages API after attempting to update the message. This typically includes confirmation of the update, the updated message details, or error information if the update failed.

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

Dependencies

  • Requires an API key credential for authenticating with the messaging platform's API.
  • Needs the base URL of the API endpoint configured in the node credentials.
  • Depends on the external Messages API service being available and accessible.

Troubleshooting

  • Common Issues:

    • Invalid or missing identifiers (Inbox, Contact, Conversation, Message) will cause the update to fail.
    • Malformed JSON in the "Submitted Values" property can lead to parsing errors.
    • Network connectivity issues or incorrect API base URL configuration may prevent successful requests.
  • Error Messages:

    • Authentication errors indicate invalid or missing API credentials; verify and update the API key/token.
    • "Message not found" or similar errors suggest incorrect Message Id or Conversation Id; double-check these values.
    • JSON parsing errors mean the submitted JSON is invalid; ensure proper JSON formatting.

Links and References

  • Refer to the official Messages API documentation of your messaging platform for detailed information on message update endpoints and payload structure.
  • Consult n8n documentation on how to configure API credentials and use JSON input properties effectively.

Discussion