The EventBridge Rule uses the specified JSON values to target specific fields within the incoming webhook payload. Let's break-down the above JSON to better understand the rule and how it targets these values in the EventBridge payload.
detail-type: Different types of events can enter the bus. Each event will desiginate itself with the "detail-type" field. In this case, Shopify is labeling all platform webhooks as, "shopifyWebhook" The pattern above is telling EventBridge to search for events with a detail-type of "shopifyWebhook" The rule will ignore any other event that doesn't match this detail-type.
detail: The "detail' portion of the rule is where you further specify the values within the webhook to search for a matching event. You can tell the rule to search for orders, customers, or virtually anything within the incoming payload. In the example above, we targeted the "metadata" fields for the search. The pattern is looking for the, "X-Shopify-Topic" value within the metadata and designating "products/update" as the desired value to match.
If this sounds a little complicated, it might help to look at a sample of the incoming event payload. Reviewing the sample below will help you better understand the rule. Let's look at an EventBridge payload. This is the data sent to EventBridge from Shopify when a webhook is initiated. We'll use the sample EventBridge payload from Shopify for this example. We've highlighted key fields in the sample payload below to show which values the rule is targeting:
