Webhook Subscription Create Payload
Return type for mutation.
Anchor to FieldsFields
- userErrors ([UserError!]!)
- webhookSubscription (WebhookSubscription)
- 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
- webhookSubscriptionCreate (WebhookSubscriptionCreatePayload)
- •mutation
Creates a webhook subscription that notifies your
Appwhen specific events occur in a shop. Webhooks push event data to your endpoint immediately when changes happen, eliminating the need for polling.The subscription configuration supports multiple endpoint types including HTTPS URLs, Google Pub/Sub topics, and AWS EventBridge event sources. You can filter events using Shopify API search syntax to receive only relevant webhooks, control which data fields are included in webhook payloads, and specify metafield namespaces to include.
NoteThe Webhooks API version configured in your app determines the API version for webhook events. You can't specify it per subscription.
Note:The Webhooks API version configured in your app determines the API version for webhook events. You can't specify it per subscription.
Note: The Webhooks API version <a href="https://shopify.dev/docs/apps/build/webhooks/subscribe/use-newer-api-version">configured in your app</a> determines the API version for webhook events. You can't specify it per subscription.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to topictopic•Webhook
Subscription Topic! required The type of event that triggers the webhook.
- Anchor to webhookSubscriptionwebhook•Webhook
Subscription Subscription Input! required Specifies the input fields for a webhook subscription.
Arguments