Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage webhooks among other resources. Specifically, for the Webhook - Update operation, it updates an existing webhook's configuration by modifying its target URL and the events it listens to. This is useful when you want to change where webhook notifications are sent or adjust which events trigger those notifications without creating a new webhook.

Practical scenarios include:

  • Changing the endpoint URL after migrating your webhook receiver service.
  • Adding or removing event types (e.g., listening to "Contact Updated" instead of "Message Created").
  • Adjusting webhook settings dynamically as part of an automated workflow.

Properties

Name Meaning
Webhook ID The numeric identifier of the webhook to update.
URL The new URL where webhook events will be sent.
Events List of event types to listen for. Options: Contact Created, Contact Updated, Conversation Created, Conversation Updated, Message Created.
Continue on Fail Whether the node should continue processing subsequent items if this update operation fails.
Debug Logging Whether to output detailed request and response information to the console for debugging purposes.

Output

The node outputs JSON data representing the updated webhook object returned from the Chatwoot API. This typically includes details such as the webhook ID, URL, subscribed events, and metadata confirming the update.

If the operation succeeds, the output JSON contains the updated webhook information. If the operation fails and "Continue on Fail" is enabled, the output will contain an error message in JSON format.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token credential for Chatwoot with access to the relevant account.
  • The node makes HTTP requests to the Chatwoot API endpoints.
  • No additional external dependencies beyond the configured Chatwoot API credentials.

Troubleshooting

  • Invalid JSON or missing parameters: Ensure that the Webhook ID is provided and valid. The URL must be a properly formatted string.
  • API authentication errors: Verify that the API key/token credential is correctly configured and has sufficient permissions.
  • Network issues: Check connectivity to the Chatwoot instance URL.
  • Debug Logging: Enable debug logging to see detailed request URLs, headers, and responses in the console, which helps diagnose issues.
  • Error messages: If the API returns an error, it will be included in the output JSON. Common errors include 404 Not Found (invalid webhook ID) or 401 Unauthorized (invalid credentials).

Links and References


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

Discussion