Actions118
- Item Actions
- Activity Actions
- Asset Actions
- Authentication Actions
- Collection Actions
- Extension Actions
- Field Actions
- File Actions
- Folder Actions
- Permission Actions
- Preset Actions
- Relation Actions
- Revision Actions
- Role Actions
- Server Actions
- Setting Actions
- User Actions
- Utility Actions
- Webhook Actions
Webhook → List
AI-generatedOverview
This node operation lists webhooks from a data source, allowing users to retrieve multiple webhook records with various filtering, sorting, and aggregation options. It is useful for scenarios where you need to fetch and process webhook data, such as monitoring webhook configurations, exporting webhook details, or integrating webhook data into workflows.
Use Case Examples
- Retrieve all webhooks without limit to analyze all webhook configurations.
- Fetch a limited number of webhooks (e.g., 50) for display or processing.
- Export webhook data in CSV, JSON, or XML format for reporting or backup.
- Apply filters and sorting to get specific webhooks based on criteria like creation date or status.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all webhook results or only up to a given limit. |
| Limit | Maximum number of webhook results to return when not returning all. |
| Split Into Items | Whether to output each element of an array as its own item, useful for processing individual webhook entries separately. |
| JSON/RAW Parameters | Whether the query and/or body parameters should be set via the value-key pair UI or JSON/RAW input. |
| Body Parameters | Body parameters as JSON or RAW input, used when JSON/RAW Parameters is enabled. |
| Additional Fields | Additional optional fields to customize the webhook list operation, including aggregation functions, export options, filtering, sorting, grouping, and metadata. |
Output
JSON
webhooks- Array of webhook objects returned from the list operation, each representing a webhook with its properties.
Dependencies
- Requires connection to the Directus API or relevant backend service to fetch webhook data.
Troubleshooting
- Common issues include invalid filter or aggregation parameters causing API errors; ensure JSON filters and aggregation functions are correctly formatted.
- Errors related to export formats may occur if unsupported formats are selected; use only csv, json, or xml as specified.
- Limit and offset parameters must be within allowed ranges; exceeding limits may cause errors or truncated results.