Subscribing to webhooks
Your app must respond to mandatory webhook topics. In addition, your app can register optional webhook topics.
Anchor to Configuring webhooks subscriptionsConfiguring webhooks subscriptions
Configure shopifyApp and setup webhook subscription with the following steps:
- The webhooks you want to subscribe to. In this example we subscribe to the
APP_UNINSTALLEDtopic. - The code to register the
APP_UNINSTALLEDtopic after a merchant installs you app. HereshopifyAppprovides anafterAuthhook. - Review the required scopes for the webhook topics, and update your app scopes as necessary.
You can't register mandatory topics using this package, you must configure those in the Partner Dashboard instead.
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.
Webhook endpoints must respond with an HTTP 200 code, or Shopify will retry.