Non-webhook fields and models Framework v1.6.0+ 

Some fields on Shopify models are non-webhook: they are not included in Shopify webhook payloads. This means they need to be manually fetched using Shopify's GraphQL API.

Your Shopify models and fields can be configured to automatically fetch these fields on incoming webhooks.

Webhook-only field configuration is only available if your Shopify connection uses Shopify API version 2025-04 or greater.

Fetch on webhook vs fetch later 

Each non-webhook field on a model that receives webhooks can be configured as follows:

• Fetch on webhook: When a webhook is received for that model, Gadget fetches the full data for that field from the Shopify API and updates the record. The field is populated as soon as the webhook is processed.
• Fetch later: This is the default for new apps. The field is not fetched when the webhook is processed. It remains null or unchanged until the next sync or reconciliation.

You can change this per field: open the field configuration for a non-webhook field on a webhook-enabled model and choose whether to fetch on webhook or fetch later.

Rate limits and request time 

When you set a non-webhook field to fetch on webhook, Gadget makes one or more requests to the Shopify API for each webhook that affects that model. For example, has many fields require paginating through queries to fetch all related child data, so a single webhook can trigger multiple API calls. Consider the following:

• Shopify API rate limits: Each request counts against your app's Shopify API rate limit. High-volume webhooks, such as orders or products, with many non-webhook fields set to fetch on webhook can potentially consume a lot of your available rate limit. This is especially true when has many fields require multiple paginated requests per webhook.
• Gadget request time: Fetching on webhook uses request time on Gadget while the API calls run. If you enable fetch on webhook for many fields or on high-traffic models, webhook processing can take longer and use more of your plan's request time.

Use fetch later for non-webhook fields when you do not need the data immediately. The nightly reconciliation will populate them without adding per-webhook API calls.

Adding non-webhook fields 

For new apps, only fields included in Shopify webhook payloads are added to models by default. Non-webhook fields are not added automatically.

To add non-webhook fields to a model:

1. Open the model in the Gadget editor.
2. Use the Add fields dropdown to add the non-webhook fields you need.
3. For each non-webhook field, configure whether to fetch on webhook or fetch later.

Available non-webhook fields 

Upgrading an existing app 

When you upgrade, existing non-webhook fields configured to fetch on webhook will continue to do so.

You can reconfigure these fields at any time: open the field configuration in the Gadget editor and choose fetch on webhook or fetch later for each non-webhook field.

You can also edit the model's schema.gadget.ts file locally by setting fetchData: "onWebhook" or fetchData: "later" on a field's Shopify config:

Reacting to fetch later fields in action code 

Fields set to fetch later are only populated during a sync or nightly reconciliation. Use the following patterns in your action code to detect and respond to those updates.

Check trigger.type to run code only when the update came from a sync or reconciliation:

Use record.changed() to run code only when a specific field was updated:

Conditionally webhook-synced models 

Some Shopify models do not have their own webhook topics but can be configured to sync when a parent model's webhook runs.

We call these conditionally webhook-synced models. When the parent model receives webhooks and has a has many relationship to such a child model, you can configure that has many field to fetch on webhook. When enabled, child records are created or updated whenever the parent's webhook is processed.

For example, ShopifyInventoryQuantity is a non-webhook model. It is related to ShopifyInventoryLevel, which receives webhooks, with the quantities field, so that ShopifyInventoryLevel has many ShopifyInventoryQuantity. When you enable fetch on webhook for the quantities field on ShopifyInventoryLevel, each inventory level webhook will create or update the related ShopifyInventoryQuantity records.

The following table lists conditionally webhook synced models. For each, configure fetch on webhook for the given field on the parent model to sync the child when the parent's webhook is processed.

Non-webhook models 

Some Shopify models have no webhook topics and cannot inherit webhooks from a parent. We call these non-webhook models. They are only updated when you run a sync. Gadget adds a scheduledShopifySync global action to keep these models up to date on a daily schedule.

The following list shows non-webhook models:

• Shopify App
• Shopify App Credit
• Shopify App Installation
• Shopify App Usage Record
• Shopify Article
• Shopify Balance Transaction
• Shopify Blog
• Shopify Business Entity
• Shopify Carrier Service
• Shopify Catalog
• Shopify Checkout Applied Gift Card
• Shopify Comment
• Shopify Country
• Shopify Discount Code
• Shopify Event
• Shopify File
• Shopify Fulfillment Service
• Shopify Gift Card
• Shopify Order Risk
• Shopify Page
• Shopify Payments Account
• Shopify Payout
• Shopify Price List
• Shopify Price List Price
• Shopify Price Rule
• Shopify Province
• Shopify Quantity Price Break
• Shopify Redirect
• Shopify Return Reason Definition
• Shopify Script Tag

Potential data inconsistencies 

There are cases where not fetching data on webhook could lead to confusion. In these special cases, Gadget notifies you on the affected model's data viewer about potential inconsistencies in data, and suggests enabling fetch on webhook for the affected field.

Those special cases are:

• Product webhooks - If the webhook payload has more variant IDs in variant_gids than full variant objects in variants, and the variants field on ShopifyProduct is not set to fetch on webhook, a banner is shown on the ShopifyProductVariant data viewer.
• Product webhooks - If the webhook payload includes media, and neither the product media nor the variant media relationship is set to fetch on webhook, a banner is shown on the ShopifyFile data viewer. The banner suggests enabling fetch on webhook for media on ShopifyProduct and/or media on ShopifyProductVariant, depending on which models you have enabled. For example, if ShopifyProductMedia is enabled, configuring media on ShopifyProduct is sufficient.
• Fulfillment order webhooks - If no non-webhook fields on ShopifyFulfillmentOrder are set to fetch on webhook, a banner is shown on the ShopifyFulfillmentOrder data viewer.