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 a customer support message after receiving new information.
  • Updating automated notification messages based on user actions.
  • Correcting or enhancing chat transcripts stored in the system.

Properties

Name Meaning
Inbox Identifier The unique identifier for 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 updated message object returned by the API. This typically includes the message's current state after the update, such as its content, timestamps, status, and any other relevant metadata.

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 message data.

Dependencies

  • Requires an API key credential for authenticating requests to the messaging platform.
  • Needs the base URL of the messaging API configured in the node credentials.
  • Depends on the external messaging service's API 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 or authentication failures if the API key or base URL is incorrect.
  • Error Messages:

    • "Message not found" — Verify that the message ID and conversation ID are correct.
    • "Unauthorized" — Check that the API key credential is valid and has necessary permissions.
    • "Invalid JSON body" — Ensure the submitted values are properly formatted JSON.

Resolving these usually involves verifying input parameters, ensuring proper credential setup, and confirming API availability.

Links and References

Discussion