ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node allows you to update an existing webhook in the ChatWoot system. Webhooks are used to receive real-time event notifications from ChatWoot by specifying a URL where these events should be sent. Updating a webhook typically involves changing its target URL or modifying the list of event subscriptions.

Common scenarios for this node include:

  • Changing the destination URL of a webhook when your receiving service endpoint changes.
  • Adjusting which events your webhook subscribes to, for example, adding or removing event types to control what notifications you receive.

Practical example:

  • You have a webhook set up to notify your CRM system about new chat messages. If your CRM endpoint URL changes, you can use this node to update the webhook URL without recreating it.
  • You want to stop receiving notifications about certain events and only keep specific ones; you can update the webhook’s subscriptions accordingly.

Properties

Name Meaning
Account Id The numeric ID of the account owning the webhook.
Webhook Id The numeric ID of the webhook to update.
Url The URL where the webhook events should be sent.
Subscriptions A JSON array defining the events to subscribe to. This controls which event types trigger the webhook.

Output

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

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node uses the base URL configured in the credentials to send requests.
  • No additional external dependencies beyond the ChatWoot API.

Troubleshooting

  • Invalid Account or Webhook ID: If the provided IDs do not exist or belong to another user, the API will return an error. Verify that the IDs are correct.
  • Malformed Subscriptions JSON: The subscriptions property expects valid JSON. Invalid JSON will cause parsing errors. Ensure the JSON syntax is correct.
  • URL Validation Errors: The webhook URL must be a valid and reachable URL. Invalid URLs may cause the API to reject the update.
  • Authentication Failures: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Connectivity problems between n8n and the ChatWoot API endpoint can cause request failures.

Links and References

Discussion