Shopware icon

Shopware

Shopware

Actions778

Webhook → Search Webhook

AI-generated

Overview

This node operation allows searching for webhooks within the Shopware system using various search parameters. It is useful for scenarios where you need to retrieve specific webhooks based on filters, sorting, pagination, and other search criteria. For example, you can search for webhooks created after a certain date, limit the number of results per page, or sort them by creation date.

Use Case Examples

  1. Search webhooks with a filter to find only active webhooks.
  2. Retrieve a specific page of webhook results with a set limit per page.
  3. Sort webhooks by their creation date in descending order.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but exact count), or next-pages (fast count for next pages).
Ids A JSON array of specific webhook IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing the returned data.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The search results containing the list of webhooks matching the search criteria.
  • total - The total number of webhooks found matching the search query, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause errors. Ensure JSON is correctly formatted.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the search operation significantly on large datasets.
  • SSL certificate validation errors can occur if 'Ignore SSL Issues' is not enabled and the server uses a self-signed certificate.

Links

Discussion