Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage messages within conversations. Specifically, the Delete Message operation allows users to delete a specific message from a conversation by providing the conversation ID and the message ID.

Common scenarios where this node is beneficial include:

  • Automating cleanup of unwanted or erroneous messages in customer support conversations.
  • Integrating with workflows that require message moderation or removal based on certain triggers.
  • Managing message lifecycle programmatically in bulk or as part of a larger automation process.

Example use case:

  • A support team uses this node to automatically delete messages flagged as inappropriate or spam in their Chatwoot conversations.

Properties

Name Meaning
Conversation ID The numeric ID of the conversation containing the message to delete.
Message ID The numeric ID of the message to be deleted within the specified conversation.
Continue on Fail Whether the node should continue processing subsequent items if this delete operation fails. (Boolean)
Debug Logging Whether to output detailed request and response information to the console for debugging purposes. (Boolean)

Output

The node outputs a JSON object indicating the success of the delete operation:

{
  "success": true
}
  • If the deletion is successful, the output JSON contains "success": true.
  • No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • The node expects the base URL and account ID for the Chatwoot instance to be configured in the credentials.
  • The node makes HTTP DELETE requests to the Chatwoot API endpoint for deleting messages.

Troubleshooting

  • Common issues:

    • Invalid or missing Conversation ID or Message ID will cause the API call to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Network connectivity issues may prevent the node from reaching the Chatwoot API.
  • Error messages:

    • Errors returned from the API are caught and can be logged if Debug Logging is enabled.
    • If "Continue on Fail" is disabled, the node execution will stop on error; enabling it allows processing to continue with error details included in the output.
    • JSON parsing errors do not apply here since no JSON input is parsed for this operation.
  • How to resolve:

    • Verify that the Conversation ID and Message ID are correct and exist in the Chatwoot system.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Enable Debug Logging to get detailed request/response logs for troubleshooting.
    • Check network connectivity and firewall settings.

Links and References

Discussion