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.
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 file
You 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
app/scopes_update: Sample Payload
Examples
app/scopes_update: Sample Payload
{ "id": 1, "shop_id": "gid://shopify/Shop/548380009", "previous": [ "read_products" ], "current": [ "read_products", "write_products" ], "updated_at": "2024-06-25T00:00:00.000Z" }
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.
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.