ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node allows you to create an integration hook in the ChatWoot platform. Integration hooks enable external applications or services to interact with ChatWoot by sending or receiving data based on specific events or triggers. This is useful for automating workflows, syncing data between systems, or extending ChatWoot's functionality.

Common scenarios include:

  • Creating a webhook that triggers when a new message arrives in a ChatWoot inbox.
  • Setting up integrations with third-party apps to automate customer support tasks.
  • Configuring custom event handlers that respond to changes in ChatWoot accounts or conversations.

For example, you might use this node to create a hook that sends conversation updates to your CRM system whenever a new message is received.

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 ID of the inbox if the integration hook is specific to an 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 account and app IDs, inbox ID if applicable, and the configured settings.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node uses the ChatWoot REST API endpoint to create integration hooks.

Troubleshooting

  • Invalid Account Id: Ensure the provided Account Id exists and is numeric.
  • Missing Required Fields: The Account Id is mandatory; missing it will cause errors.
  • API Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Malformed Settings JSON: The Settings property must be valid JSON; invalid JSON will cause parsing errors.
  • Inbox Id Usage: If creating an inbox-specific hook, ensure the Inbox Id is correct and belongs to the specified account.

Links and References

Discussion