ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to create a webhook subscription in the ChatWoot system. By creating a webhook, you can configure ChatWoot to send event notifications to a specified URL whenever certain events occur in your account. This is useful for integrating ChatWoot with other systems or automating workflows based on real-time events.

Common scenarios include:

  • Receiving notifications about new messages or conversations.
  • Triggering external processes when specific events happen in ChatWoot.
  • Synchronizing ChatWoot data with other applications via webhooks.

For example, you might create a webhook that sends conversation updates to your CRM system or triggers alerts in a monitoring tool.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the webhook will be created.
Url The destination URL where ChatWoot will send event notifications (webhook payloads).
Subscriptions A JSON array specifying which events you want to subscribe to for this webhook.

Output

The node outputs JSON data representing the response from the ChatWoot API after creating the webhook. This typically includes details about the newly created webhook such as its ID, subscribed events, and status.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account Id: Ensure the provided account ID exists and is accessible with your API credentials.
  • Malformed Subscriptions JSON: The subscriptions property expects valid JSON. Invalid JSON will cause request failures.
  • URL Issues: The webhook URL must be reachable and accept POST requests. If unreachable, events will not be delivered.
  • Authentication Errors: Verify that the API key/token is correct and has sufficient permissions.
  • API Rate Limits: Excessive webhook creation attempts may trigger rate limiting by ChatWoot.

Links and References

Discussion