ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to update an integration hook for a specific account in ChatWoot via the "Update An Integrations Hook" operation. It is useful when you need to programmatically modify the settings of an existing integration hook, such as updating webhook URLs or authentication details for integrations connected to your ChatWoot account.

Common scenarios:

  • Automating updates to integration hooks after changes in external services.
  • Managing multiple integration configurations across different accounts.
  • Keeping integration settings synchronized with other systems.

Example:
If you have a webhook integration that needs its endpoint updated due to infrastructure changes, this node can automate the process by updating the relevant hook's settings.


Properties

Display Name Type Description
Account Id Number The numeric ID of the account.
Hook Id Number The numeric ID of the integration hook.
Settings JSON The settings required by the integration.
  • Account Id: Specifies which ChatWoot account the integration hook belongs to.
  • Hook Id: Identifies the specific integration hook to be updated.
  • Settings: A JSON object containing the new configuration for the integration hook (e.g., URLs, tokens, or other parameters required by the integration).

Output

The node outputs a json field containing the response from the ChatWoot API after updating the integration hook. The structure typically includes:

{
  "id": <number>,
  "account_id": <number>,
  "settings": { /* updated settings object */ },
  // ...other fields returned by the ChatWoot API
}
  • id: The unique identifier of the integration hook.
  • account_id: The account associated with the hook.
  • settings: The updated settings as provided in the input.

Note: The exact output fields may vary depending on the ChatWoot API response.


Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: You must configure n8n credentials named chatwootApi, including at least the base URL and any required authentication tokens.
  • n8n Configuration: Ensure the node has network access to the ChatWoot API endpoint.

Troubleshooting

Common Issues:

  • Invalid Account or Hook ID: If the provided IDs do not exist, the API will likely return a "Not Found" error.
  • Malformed Settings JSON: If the Settings property is not valid JSON, the request will fail. Always ensure the JSON is correctly formatted.
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
  • Insufficient Permissions: The API key used must have permission to update integration hooks.

Error Messages & Resolutions:

  • "404 Not Found": Check that both Account Id and Hook Id are correct and exist in ChatWoot.
  • "401 Unauthorized": Verify that your API credentials are set up correctly in n8n.
  • "400 Bad Request": Ensure the Settings JSON is valid and all required fields are present.

Links and References

Discussion