Webhook
An auto-generated type for paginating through multiple WebhookSubscriptions.
Anchor to Queries with this connectionQueries with this connection
- webhookSubscriptions (WebhookSubscriptionConnection!)
- •query
Retrieves a paginated list of webhook subscriptions created using the API for the current app and shop.
NoteReturns only shop-scoped subscriptions, not app-scoped subscriptions configured in TOML files.
Note:Returns only shop-scoped subscriptions, not app-scoped subscriptions configured in TOML files.
Note: Returns only shop-scoped subscriptions, not app-scoped subscriptions configured in TOML files.
Subscription details include event topics, endpoint URIs, filtering rules, field inclusion settings, and metafield namespace permissions. Results support cursor-based pagination that you can filter by topic, format, or custom search criteria.
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 firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Webhook
Key Subscription Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to callbackUrlcallback•URL
Url Deprecated - •String
URI to filter by. Supports an HTTPS URL, a Google Pub/Sub URI (pubsub://{project-id}:{topic-id}) or an Amazon EventBridge event source ARN.
- Anchor to formatformat•Webhook
Subscription Format Response format to filter by.
- Anchor to topicstopics•[Webhook
Subscription Topic!] List of webhook subscription topics to filter by.
Arguments
Anchor to Possible returnsPossible returns
- edges ([WebhookSubscriptionEdge!]!)
- nodes ([WebhookSubscription!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Webhook
Subscription Edge!]! non-null The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Webhook
Subscription!]! non-null A list of nodes that are contained in WebhookSubscriptionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
- Anchor to pageInfopage•Page
Info Info! non-null An object that’s used to retrieve cursor information about the current page.