ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node allows updating an integration hook within a specified account in the ChatWoot system. Integration hooks are typically used to connect ChatWoot with external services or automate workflows by sending event data to other platforms. This operation is useful when you need to modify the configuration or settings of an existing integration hook, such as changing webhook URLs, authentication tokens, or other parameters required by the integration.

Practical examples include:

  • Updating the callback URL of a webhook integration after migrating to a new server.
  • Changing authentication credentials or settings for an integration without recreating it.
  • Adjusting integration parameters dynamically based on evolving business requirements.

Properties

Name Meaning
Account Id The numeric ID of the account where the integration hook exists.
Hook Id The numeric ID of the specific integration hook to update.
Settings A JSON object containing the updated settings required by the integration hook. These settings vary depending on the integration's needs and may include URLs, tokens, flags, or other configuration data.

Output

The node outputs JSON data representing the response from the ChatWoot API after attempting to update the integration hook. This typically includes confirmation of the update, the current state of the integration hook, or error details if the update failed.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node depends on the ChatWoot API endpoint configured via credentials, including the base URL.
  • Uses the @devlikeapro/n8n-openapi-node package internally to build properties and handle requests based on the OpenAPI specification.

Troubleshooting

  • Invalid Account Id or Hook Id: If either ID does not exist or is incorrect, the API will return an error indicating the resource was not found. Verify IDs before running the node.
  • Malformed Settings JSON: The Settings property must be valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions to update integration hooks.
  • Network Issues: Connectivity problems or incorrect base URL configuration can lead to request failures. Confirm network access and credential URL correctness.

Links and References

Discussion