Subscribing to webhooks

Anchor to App-specific webhooks (recommended)App-specific webhooks (recommended)

The easiest way to configure webhooks is to use app-specific webhooks in shopify.app.toml. You can find more info in the webhooks documentation.

To set up a simple HTTPS webhook subscription, you can follow these steps:

1. Add the topic to subscribe to in shopify.app.toml. In this example we subscribe to the APP_UNINSTALLED topic.
2. Review the required scopes for the webhook topics, and update your app scopes as necessary.
3. Run shopify app deploy from the CLI to save your webhooks configuration.

Anchor to Shop-specific webhooksShop-specific webhooks

Shop-specific webhooks are useful when you need to subscribe to different webhook topics for different shops, or when a topic is not supported by app-specific webhooks.Configure shopifyApp and to setup shop-specific webhook subscriptions with the following steps:

1. The webhooks you want to subscribe to. In this example we subscribe to the APP_UNINSTALLED topic.
2. The code to register the APP_UNINSTALLED topic after a merchant installs you app. Here shopifyApp provides an afterAuth hook.
3. Review the required scopes for the webhook topics, and update your app scopes as necessary.

Anchor to Set up your endpointsSet up your endpoints

Create a route in your app to handle incoming webhook requests for each callbackUrl you set in your configuration.Legitimate webhook requests are always POST requests signed by Shopify, so you must authenticate them before taking any action. To do this you must set up an action that uses the authenticate.webhook function to authenticate the request.

Please keep in mind that webhook endpoints should respond as quickly as possible. If you need to run a long-running job, then consider using background tasks.