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 real-time event notifications from ChatWoot, such as new messages or updates in inboxes. This is useful for automating workflows, syncing data with other platforms, or triggering custom actions when certain events occur.

Practical examples include:

  • Creating a webhook to notify your CRM system whenever a new conversation starts.
  • Setting up an integration hook to forward incoming messages to a third-party analytics service.
  • Automating ticket creation in an external helpdesk tool based on ChatWoot inbox activity.

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 (optional).
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. This typically includes details such as the hook's unique ID, associated account and app IDs, inbox information if applicable, and the configured settings. The output can be used downstream in workflows to reference or log the created hook.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Network access to the ChatWoot API endpoint is necessary.

Troubleshooting

  • Missing or invalid Account Id: Ensure that the Account Id is provided and corresponds to an existing ChatWoot account.
  • Invalid JSON in Settings: The Settings property must be valid JSON; otherwise, parsing errors will occur.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network issues: Confirm that the ChatWoot API URL is reachable from the n8n environment.
  • App Id or Inbox Id not found: If specified, these IDs must exist in the target account; otherwise, the API may return errors.

Links and References

Discussion