Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage conversations within a customer support or engagement platform. Specifically, the Update Status operation for the Conversation resource allows users to change the status of an existing conversation (e.g., marking it as open, resolved, or pending). This is useful in scenarios where you want to programmatically update the state of a customer interaction based on workflow logic, such as closing tickets after resolution or flagging conversations that need follow-up.

Practical examples:

  • Automatically mark a conversation as "resolved" once a support agent completes a task.
  • Set a conversation to "pending" if awaiting customer response.
  • Reopen a conversation by setting its status back to "open".

Properties

Name Meaning
Conversation ID The numeric ID of the conversation to update.
Status The new status to set for the conversation. Options: Open, Resolved, Pending.
Continue on Fail Whether the node should continue processing subsequent items if this operation fails.
Debug Logging Whether to output detailed request and response information to the console for debugging.

Output

The node outputs JSON data representing the updated conversation object returned from the Chatwoot API after the status update. This typically includes all conversation details such as ID, status, timestamps, participants, messages summary, and other metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • Needs the account ID and base URL configured in the credentials.
  • The node makes HTTP PUT requests to the Chatwoot API endpoint /api/v1/accounts/{accountId}/conversations/{conversationId} with a JSON body containing the new status.

Troubleshooting

  • Invalid Conversation ID: If the provided conversation ID does not exist or is incorrect, the API will return an error. Verify the ID before running the node.
  • Invalid Status Value: Only the statuses open, resolved, and pending are accepted. Using any other value will cause the API to reject the request.
  • Authentication Errors: Ensure the API key credential is valid and has access to the specified account.
  • JSON Parsing Errors: Not applicable here since the status is a simple string, but enabling debug logging can help identify malformed requests.
  • Network Issues: Check connectivity to the Chatwoot instance URL.

If the node throws errors, enabling Debug Logging will print detailed request URLs, headers, and responses to the console, aiding diagnosis.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion