Shopware icon

Shopware

Shopware

Actions778

Webhook Event Log → Search Webhook Event Log

AI-generated

Overview

This node operation allows searching the Webhook Event Log in Shopware. It is useful for retrieving and filtering webhook event data based on various criteria such as pagination, filters, sorting, and specific fields. This can help users monitor webhook events, analyze event logs, and troubleshoot webhook-related issues by querying the event log data efficiently.

Use Case Examples

  1. Retrieve the first page of webhook event logs with a limit of 50 entries per page.
  2. Search webhook event logs with specific filters to find events related to a particular webhook or status.
  3. Sort webhook event logs by date or event type to analyze trends or issues.
  4. Use aggregations and groupings to summarize webhook event data for reporting purposes.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result.
Filter A JSON list of filters to restrict the search results based on specific criteria.
Sort A JSON list defining the sorting order of the search results.
Post Filter A JSON list 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 list defining aggregations to perform on the search results.
Grouping A JSON list defining groupings over certain fields in the search results.
Fields A JSON list 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 accurate), or next-pages (fast for next page).
Ids A JSON list of specific IDs to search for in the webhook event log.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • data - The search results containing the webhook event log entries matching the query.
  • total - The total number of matching webhook event log entries, if total count mode is enabled.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have permission to access webhook event logs.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to exact, expect slower response times for large datasets.
  • Check network settings if using proxy or if SSL certificate validation is disabled, as these can affect connectivity and security.

Links

Discussion