ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Integrations → Create An Integration Hook

AI-generated

Overview

This node interacts with the ChatWoot API to create an integration hook for a specified account. Integration hooks allow external applications or services to connect and interact with ChatWoot, enabling automation and data synchronization scenarios. For example, you might use this node to set up a webhook that triggers when new messages arrive in a specific inbox or to integrate a third-party app with your ChatWoot account.

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 related to a specific inbox.
Settings A JSON object containing configuration settings required by the integration hook.

Output

The node outputs JSON data representing the response from the ChatWoot API after creating the integration hook. This typically includes details about the newly created hook such as its ID, status, and configuration. If the integration hook creation fails, the output will contain error information.

The node does not output binary data.

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 provided in the credentials.

Troubleshooting

  • Invalid Account Id: Ensure the Account Id is correct and exists in your ChatWoot instance.
  • Authentication Errors: Verify that the API key or token used in credentials is valid and has sufficient permissions.
  • Malformed Settings JSON: The "Settings" property must be valid JSON; otherwise, the request will fail.
  • Missing Required Fields: The Account Id is mandatory; missing it will cause errors.
  • API Endpoint Issues: Check network connectivity and the correctness of the ChatWoot base URL.

Common error messages may include unauthorized access, invalid parameters, or server errors. Resolving these usually involves checking credentials, input values, and API availability.

Links and References

Discussion