Webhook best practices
The following guide describes some best practices for working with webhooks.
Respond quicklyAnchor link to section titled "Respond quickly"
After receiving a webhook using an HTTPS endpoint, it's important to respond to the request with a
200 OK as quickly as possible.
A common pattern is to store the payload in a message queue for later processing by a background worker. This reduces the chance of the request timing out and the webhook delivery counting as a failure.
Track failuresAnchor link to section titled "Track failures"
Use delivery metrics to track any failed webhook deliveries and fix them before they affect merchants.
Recover webhooksAnchor link to section titled "Recover webhooks"
If your app goes offline for an extended period of time, you can recover your webhook by re-registering it and importing the missing data.
To re-register a webhook, consult the app's code that initially registered the webhook. You can add a check that fetches all the existing webhooks and registers only the ones that you need.
To import the missing data, you can fetch data from the outage period and feed it into your webhook processing code.
Avoid debouncesAnchor link to section titled "Avoid debounces"
When you use the
fields parameter to specify which fields should be sent by a webhook, include a field that always has a unique value. For example, you can include the
updated_at field in the
Including a field that always has a unique value prevents the webhook from being dropped as a duplicate, such as in cases when only the
id field is requested.
Ignore duplicatesAnchor link to section titled "Ignore duplicates"
Although the webhooks API is designed to minimize duplicate webhook events, it is still possible to receive the same event more than once. Your app should handle webhook events using idempotent operations; that is, receiving the same webhook event a second time in a row should have no additional effect. You can detect duplicate webhook events by looking for identical
X-Shopify-Webhook-Id headers, or by comparing the payload directly to the previous state.
Manage delaysAnchor link to section titled "Manage delays"
In rare circumstances, you might experience delays in receiving webhooks. However, webhooks are always sent with the most recent data for the given resource. The payload of the delivered webhook should reflect the most recent attributes for the resource between the time of the webhook's trigger and the webhook's eventual delivery.
If receiving webhooks up to a day late might cause issues in your app, then we recommend comparing the timestamp of the webhook to the current time.
Implement reconciliation jobsAnchor link to section titled "Implement reconciliation jobs"
Your app shouldn't rely solely on receiving data from Shopify webhooks. Because webhook delivery isn't always guaranteed, you should implement reconciliation jobs to periodically fetch data from Shopify.
Use supported filter parametersAnchor link to section titled "Use supported filter parameters"
Most query endpoints support both the
updated_at_min filter parameters. These filters can be used to build a job that fetches all resources that have been created or updated since the last time the job ran.
Build a scalable and reliable systemAnchor link to section titled "Build a scalable and reliable system"
Tracking traffic from Shopify's platform can be overwhelming, especially as you grow your app.
If you need to manage large volumes of event notifications to build a scalable and reliable system, then you can configure subscriptions to send webhooks to Amazon EventBridge and Google Cloud Pub/Sub rather than through HTTPS.
- Learn about configuring webhooks for your app.