Webhooks configuration overview

Shopify can send webhook events through several different delivery method endpoints. Each delivery method requires different types of setup.

Requirements

  • You're familiar with how webhooks work.
  • You're authenticated with the GraphQL Admin API or REST Admin API.

Webhook configuration flow

To receive webhooks, you must complete the following steps:

  1. Create an endpoint of your choice
  2. Use the GraphQL Admin API or REST Admin API to create a webhook subscription that uses the endpoint as its destination.
  3. Trigger webhook events that match the topic of the new subscription.

The process for each step differs depending on the type of endpoint you choose.

Supported endpoint types

Shopify offers webhook delivery for three types of endpoints:

  • HTTPS: You create an HTTPS endpoint on your app as a webhook receiver, and specify that endpoint's URL as the webhook subscription's endpoint.
  • Amazon EventBridge: You create an Amazon EventBridge EventBus linked to a Shopify EventSource, and specify the ARN of the EventSource as the webhook subscription's endpoint.
  • Google Cloud Pub/Sub: You create a Google Cloud Pub/Sub topic to which Shopify can publish messages, and specify that topic as the webhook subscription's endpoint.

The Amazon EventBridge and Google Cloud Pub/Sub endpoints offer reliable, scalable solutions for handling unpredictable webhook volume. They are only available to apps using AWS or Google Cloud.

Any app can use HTTPS endpoints, but they can be difficult to scale to a large volume of webhook traffic.