Webhook Subscription Create Payload
Return type for mutation.
Anchor to FieldsFields
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•Webhook
Subscription Subscription The webhook subscription that was created.
Anchor to Mutations with this payloadMutations with this payload
- •mutation
Set up webhook subscriptions so your app gets notified instantly when things happen in a merchant's store. Instead of constantly checking for changes, webhooks push updates to your app the moment they occur, making integrations faster and more efficient.
For example, an inventory management app might create subscriptions for
and
events to automatically adjust stock levels and trigger fulfillment processes when customers complete purchases.
Use
to:
- Set up real-time event notifications for your app
- Configure specific topics like order creation, product updates, or customer changes
- Define endpoint destinations (HTTPS, EventBridge, or Pub/Sub)
- Filter events using Shopify search syntax to receive notifications only for relevant events
- Configure field inclusion to control which data fields are included in webhook payloads
The mutation supports multiple endpoint types and advanced filtering options, allowing you to create precisely targeted webhook subscriptions that match your app's integration needs. The API version is inherited from the app configuration and cannot be specified per subscription. Filters use Shopify search syntax to determine which events trigger notifications.
Successful creation returns the webhook subscription fields that you request in your query. The mutation validates topic availability, filter syntax, and endpoint configuration.
Learn more about creating webhook subscriptions.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.toml
may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.