WebhookSubscription

object

A webhook subscription is a persisted data object created by an app using the REST Admin API or GraphQL Admin API. It describes the topic that the app wants to receive, and a destination where Shopify should send webhooks of the specified topic. When an event for a given topic occurs, the webhook subscription sends a relevant payload to the destination. Learn more about the webhooks system.

Anchor to FieldsFields

Anchor to apiVersionapiVersion • ApiVersion!non-null: The Admin API version that Shopify uses to serialize webhook events. This value is inherited from the app that created the webhook subscription.
Anchor to createdAtcreatedAt • DateTime!non-null: The date and time when the webhook subscription was created.
Anchor to endpointendpoint • WebhookSubscriptionEndpoint!non-null: The endpoint to which the webhook subscription will send events.
Anchor to formatformat • WebhookSubscriptionFormat!non-null: The format in which the webhook subscription should send the data.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to includeFieldsincludeFields • [String!]!non-null: An optional array of top-level resource fields that should be serialized and sent in the webhook message. If null, then all fields will be sent.
Anchor to legacyResourceIdlegacyResourceId • UnsignedInt64!non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to metafieldNamespacesmetafieldNamespaces • [String!]!non-null: The list of namespaces for any metafields that should be included in the webhook subscription.
Anchor to topictopic • WebhookSubscriptionTopic!non-null: The type of event that triggers the webhook. The topic determines when the webhook subscription sends a webhook, as well as what class of data object that webhook contains.
Anchor to updatedAtupdatedAt • DateTime!non-null: The date and time when the webhook subscription was updated.

Show

deprecated fields Deprecated

Anchor to callbackUrlcallbackUrl • URL!non-nullDeprecated: The destination URI to which the webhook subscription will send a message when an event occurs. Use endpoint instead.
Anchor to privateMetafieldNamespacesprivateMetafieldNamespaces • [String!]!non-nullDeprecated: The list of namespaces for private metafields that should be included in the webhook subscription. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
Anchor to subTopicsubTopic • StringDeprecated: An additional constraint to refine the type of event that triggers the webhook. Only supported on certain topics. See our guide to sub-topics for more. Use filter instead.

Was this section helpful?

Anchor to QueriesQueries

Anchor to webhookSubscription webhookSubscription • query: Returns a webhook subscription by ID.

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.
Anchor to webhookSubscriptions webhookSubscriptions • query: Returns a list of 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.

Was this section helpful?

Anchor to MutationsMutations

Anchor to eventBridgeWebhookSubscriptionCreate eventBridgeWebhookSubscriptionCreate • mutation: Creates a new Amazon EventBridge webhook 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.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Anchor to eventBridgeWebhookSubscriptionUpdate eventBridgeWebhookSubscriptionUpdate • mutation: Updates an Amazon EventBridge webhook 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.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Anchor to pubSubWebhookSubscriptionCreate pubSubWebhookSubscriptionCreate • mutation: Creates a new Google Cloud Pub/Sub webhook 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.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Anchor to pubSubWebhookSubscriptionUpdate pubSubWebhookSubscriptionUpdate • mutation: Updates a Google Cloud Pub/Sub webhook 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.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Anchor to webhookSubscriptionCreate webhookSubscriptionCreate • mutation: Creates a new webhook 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.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Anchor to webhookSubscriptionUpdate webhookSubscriptionUpdate • mutation: Updates a webhook 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.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to LegacyInteroperability LegacyInteroperability • interface
Anchor to Node Node • interface

Was this section helpful?