ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to create an integration hook within a specified account in ChatWoot. Integration hooks enable external applications or services to receive event notifications or interact with ChatWoot data programmatically. This is useful for automating workflows, syncing data between platforms, or triggering actions based on ChatWoot events.

For example, you might use this node to set up a webhook that notifies your CRM system whenever a new conversation starts in ChatWoot, or to integrate a custom app that processes incoming messages automatically.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the integration hook will be created.
App Id The identifier of the app for which the integration hook is being created.
Inbox Id The inbox ID if the integration hook is specific to a particular inbox (optional).
Settings A JSON object containing configuration settings required by the integration hook.

Output

The node outputs JSON data representing the newly created integration hook as returned by the ChatWoot API. This typically includes details such as the hook's unique ID, associated app and inbox IDs, settings, creation timestamps, and status.

If the integration hook creation involves binary data (not indicated here), it would be summarized accordingly, but in this case, output is purely JSON.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the ChatWoot instance must be provided in the credentials.
  • The node uses HTTP requests with JSON payloads to communicate with the ChatWoot API.

Troubleshooting

  • Invalid Account Id: Ensure the numeric account ID is correct and that the authenticated user has permission to create hooks in that account.
  • Missing Required Fields: The "Account Id" is mandatory; missing it will cause errors.
  • Malformed JSON in Settings: The "Settings" property expects valid JSON. Invalid JSON syntax will cause parsing errors.
  • API Authentication Errors: Verify that the API key/token is valid and has sufficient permissions.
  • Network Issues: Check connectivity to the ChatWoot server and ensure the base URL is correctly configured.

Common error messages may include unauthorized access, invalid parameters, or JSON parsing failures. Resolving these usually involves verifying input values, credentials, and network configurations.

Links and References

Discussion