Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node integrates with the Chatwoot API to manage webhooks associated with a specific account. The "Get Many" operation for the "Webhook" resource retrieves a list of all webhooks configured under a given account. This is useful for scenarios where you want to programmatically fetch and review all webhook endpoints registered in your Chatwoot account, such as for auditing, monitoring, or synchronizing webhook configurations.

Practical examples:

  • Automatically retrieving all webhooks to display them in a dashboard.
  • Syncing webhook URLs from Chatwoot into another system.
  • Validating that expected webhooks exist before performing updates or deletions.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account whose webhooks you want to retrieve (required).
Continue on Fail Whether to continue executing subsequent items if this operation fails (boolean).

Output

The output is an array of JSON objects, each representing a webhook configured in the specified account. Each webhook object contains details as returned by the Chatwoot API, typically including fields like webhook ID, URL, subscribed events, and other metadata.

Example structure of one webhook item in json output:

{
  "id": 123,
  "url": "https://example.com/webhook",
  "events": [
    "contact_created",
    "conversation_updated"
  ],
  "account_id": 1,
  ...
}

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Chatwoot API via an API key credential.
  • The node expects the base URL of the Chatwoot instance to be configured in credentials.
  • Network access to the Chatwoot API endpoint must be available.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the API request to fail.
    • Network connectivity problems can prevent successful API calls.
    • Insufficient permissions on the API key may result in authorization errors.

  • Error messages:

    • "404 Not Found": The specified account does not exist or the account ID is incorrect.
    • "401 Unauthorized": The API key credential is invalid or lacks required permissions.
    • "500 Internal Server Error": Temporary server issue; retry after some time.

  • Resolutions:

    • Verify the Account ID is correct and exists in Chatwoot.
    • Ensure the API key credential is valid and has appropriate scopes.
    • Check network connectivity and firewall settings.
    • Enable "Continue on Fail" if you want the workflow to proceed despite individual failures.

Links and References

Discussion