Directus (denkhaus)Install

Overview

This node is designed to interact with a "Webhook" resource, specifically performing the "List" operation. It allows users to retrieve a list of webhooks from an external service, with flexible options for filtering, sorting, aggregation, and exporting results in various formats (CSV, JSON, XML). This node is beneficial when you need to programmatically access, analyze, or export webhook configurations or logs from your system.

Common scenarios:

• Auditing all registered webhooks in your application.
• Exporting webhook data for backup or reporting purposes.
• Filtering and aggregating webhook records for analytics.
• Integrating webhook data into other workflows or systems.

Practical examples:

• Retrieve all webhooks and export them as a CSV file for compliance review.
• List only webhooks created by a specific user or matching certain criteria.
• Aggregate webhooks by event type to see which events are most commonly used.

Properties

Name	Meaning
Return All	Whether to return all results or only up to a given limit. If set to false, the "Limit" property determines the maximum number of results.
Limit	Max number of results to return. Only shown if "Return All" is false. Accepts values between 1 and 100.
Split Into Items	Whether to output each element of an array as its own item. Useful for downstream processing in n8n.
JSON/RAW Parameters	Whether the query and/or body parameters should be set via the value-key pair UI or as raw JSON.
Body Parameters	Body parameters as JSON or RAW. Only available if "JSON/RAW Parameters" is enabled.
Additional Fields	Collection of advanced options:
- Aggregate	Aggregate functions to perform calculations on a set of values (e.g., Average, Count, Maximum, Minimum, SUM, etc.) on specified fields.
- Binary Property for Export Data	Name of the binary property to download the exported data to. Default is "data".
- Deep (JSON)	Set nested query parameters for relational datasets as JSON.
- Export	Saves the API response to a file. Options: csv, json, xml.
- File Name for Export Data	File name for the exported data (without extension). Default is "export".
- Fields	Specify which fields to return in the object.
- Filter (JSON)	Select items in collection by given conditions, provided as JSON.
- Group By	Group results by one or more fields (e.g., author, year(publish_date)). Enables grouped aggregations.
- Meta	Specify what metadata to return in the response.
- Offset	How many items to skip when fetching data.
- Search	Filter items that contain the given search query in any field.
- Sort	How to sort the returned items. Provide a comma-separated list of fields; use minus sign (-) for descending order, or question mark (?) for random sorting.

Output

• The node outputs a json field containing the list of webhooks matching the specified filters and options.
• If "Export" is selected, the data may also be available as a binary file (CSV, JSON, or XML), stored under the property name specified in "Binary Property for Export Data".
• When "Split Into Items" is enabled, each webhook is output as a separate item in the workflow.

Example Output Structure

[
  {
    "json": {
      "id": "123",
      "name": "Order Created Webhook",
      "url": "https://example.com/webhook",
      // ...other webhook properties
    }
  },
  {
    "json": {
      "id": "124",
      "name": "User Signup Webhook",
      "url": "https://example.com/signup-webhook"
      // ...other webhook properties
    }
  }
]

If exporting as binary:

• The binary property (default: data) will contain the exported file (CSV, JSON, or XML).

Dependencies

• Requires access to the external service's API where webhooks are managed.
• May require API credentials or authentication configured in n8n.
• No additional npm dependencies beyond those bundled with the node.

Troubleshooting

Common issues:

• Authentication errors: Ensure API credentials are correctly configured in n8n.
• Invalid filter or aggregation syntax: Double-check JSON formatting in "Filter (JSON)" or "Deep (JSON)" fields.
• Export errors: If the export fails, verify that the "File Name for Export Data" does not contain invalid characters and that the "Export" format is supported.
• Empty results: Check your filters, search terms, or offset/limit settings.

Error messages and resolutions:

• "Invalid JSON in filter/deep parameter" – Make sure the JSON is properly formatted.
• "API key missing or invalid" – Confirm that your credentials are set up in n8n.
• "Unsupported export format" – Only csv, json, and xml are supported.

Links and References

• n8n Documentation
• Webhooks Explained
• CSV File Format
• JSON File Format
• XML File Format