Webhook
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 apiVersionapi•Api
Version Version!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 createdAtcreated•Date
At Time!non-null The date and time when the webhook subscription was created.
- Anchor to endpointendpoint•Webhook
Subscription Endpoint!non-null The endpoint to which the webhook subscription will send events.
- Anchor to filterfilter•String
A constraint specified using search syntax that ensures only webhooks that match the specified filter are emitted. See our guide on filters for more details.
- Anchor to formatformat•Webhook
Subscription Format!non-null The format in which the webhook subscription should send the data.
- •ID!non-null
A globally-unique ID.
- Anchor to includeFieldsinclude•[String!]!non-null
Fields 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 legacyResourceIdlegacy•Unsigned
Resource Id Int64!non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to metafieldNamespacesmetafield•[String!]!non-null
Namespaces The list of namespaces for any metafields that should be included in the webhook subscription.
- Anchor to metafieldsmetafields•[Webhook
Subscription Metafield Identifier!]!non-null The list of identifiers specifying metafields to include in the webhook subscription.
- Anchor to topictopic•Webhook
Subscription Topic!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 updatedAtupdated•Date
At Time!non-null The date and time when the webhook subscription was updated.
- Anchor to callbackUrlcallback•URL!non-nullDeprecated
Url
Anchor to QueriesQueries
- •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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Anchor to MutationsMutations
- •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.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•Event
Subscription Bridge Webhook Subscription Input!required Specifies the input fields for an EventBridge webhook subscription.
Arguments
- 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.
Fields
- •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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •ID!required
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhook•Event
Subscription Bridge Webhook Subscription Input!required Specifies the input fields for an EventBridge webhook subscription.
Arguments
- 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 updated.
Fields
- •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.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•Pub
Subscription Sub Webhook Subscription Input!required Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.
Arguments
- Anchor to userErrorsuser•[Pub
Errors Sub Webhook Subscription Create User 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.
Fields
- •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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •ID!required
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhook•Pub
Subscription Sub Webhook Subscription Input!required Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.
Arguments
- Anchor to userErrorsuser•[Pub
Errors Sub Webhook Subscription Update User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•Webhook
Subscription Subscription The webhook subscription that was updated.
Fields
- •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.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
- 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.
Fields
- •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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •ID!required
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhook•Webhook
Subscription Subscription Input!required Specifies the input fields for a webhook subscription.
Arguments
- 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 updated.
Fields