Skip to main content

Webhooks

The list of all webhook topics you can subscribe to. You can use webhook subscriptions to receive notifications about particular events in a shop.

Caution

If your app is distributed through the Shopify App Store, it must be subscribed to Shopify's mandatory compliance topics. You can create mandatory compliance webhook subscriptions either using your Partner Dashboard or by updating your app configuration file.

Anchor to Getting startedGetting started

Creating subscriptions using the app configuration fileYou can subscribe to most topics through your app configuration file using CLI version 3.63.0 or greater.

If you create and manage your subscriptions in your app configuration file, they will be used across all shops that your app is installed on.

Creating subscriptions using GraphQL Admin API

You can make app-specific subscriptions to all non-compliance topics through your app configuration file, or shop-specific subscriptions by Shopify's GraphQL Admin API.

For subscriptions managed with the GraphQL Admin API, use the webhookSubscriptionCreate mutation. Specify the $topic and $webhookSubscription parameters to create subscriptions.

Anchor to List of topicsList of topics

All webhook topics you can subscribe to.

Was this section helpful?

app_purchases_one_time/update: Sample Payload

{
"app_purchase_one_time": {
"admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262349",
"name": "Webhook Test",
"status": "PENDING",
"admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
"created_at": "2021-12-31T19:00:00-05:00",
"updated_at": "2021-12-31T19:00:00-05:00"
}
}

Anchor to CustomizeCustomize

Filter events

Manage the number of event messages your app receives by filtering events. Unlike payload modifications, filters are made up of rules, applied to a webhook subscription, which act as a gate for whether or not webhooks are delivered when an event occurs.

Navigate toWebhooks filters guide
Navigate toShopify API Search Syntax
Modify payloads

Shopify provides you with a way to modify the payload you receive when you subscribe to webhook topics. Unlike filters, which always return the same payload, this feature enables you to specify what subset of information is most relevant to your use case from a webhook.

Navigate toWebhooks payload modification guide
Use alongside Events

For topics with Events support, you can run both an Events subscription and a webhook in the same shopify.app.toml. Events gives you field-level triggers and custom GraphQL payloads. Use webhooks for topics that don't yet have Events support.

Info

Events require Shopify CLI 3.92 or higher. Run shopify version to check your version.

CompareEvents and webhooks
ReferenceEvents reference
Was this page helpful?