Choose a version:

webhookSubscriptions

query

Retrieves a paginated list of shop-scoped webhook subscriptions configured for the current app. This query returns webhook subscriptions created via the API for this shop, not including app-scoped subscriptions configured via TOML files.

For example, an app dashboard might use this query to display all configured webhooks, showing which events trigger notifications and their delivery endpoints for troubleshooting integration issues.

Use the webhookSubscriptions query to:

Audit all active shop-scoped webhook configurations
View and manage webhook subscription configurations
Display subscription details in app dashboards
Retrieve existing webhook configurations for dynamic integration setups
Check which subscriptions already exist before creating new ones

The query returns comprehensive subscription data including event topics, endpoint configurations, filtering rules, API versions, and metafield namespace permissions. Each subscription includes creation and modification timestamps for tracking configuration changes.

Results support standard GraphQL pagination patterns with cursor-based navigation, allowing efficient retrieval of large webhook subscription lists. The response includes detailed endpoint information varying by type - HTTP callback URLs, EventBridge ARNs, or Pub/Sub project and topic specifications.

Advanced subscription features like event filtering using Shopify search syntax, field inclusion rules, and metafield namespace access are fully exposed, providing complete visibility into webhook configuration.

Learn more about webhook subscription queries.

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 Arguments

WebhookSubscriptionConnection arguments

•WebhookSubscriptionConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to formatformat

•WebhookSubscriptionFormat

Response format to filter by.

Anchor to lastlast

•Int

The last n elements from the paginated list.

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 created_at •time
Anchor to id •id: Filter by id range.
Anchor to updated_at •time

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•WebhookSubscriptionSortKeys

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 topicstopics

•[WebhookSubscriptionTopic!]

List of webhook subscription topics to filter by.

Anchor to uriuri

•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 callbackUrlcallbackUrl

•URL

Deprecated

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[WebhookSubscriptionEdge!]! 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 •[WebhookSubscription!]! 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 pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Get the IDs, topics and URIs of the first 2 webhook subscriptions

Query

query {
  webhookSubscriptions(first: 2) {
    edges {
      node {
        id
        topic
        uri
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscriptions(first: 2) { edges { node { id topic uri } } } }"
}'

Remix

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }`,
);

const data = await response.json();

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }`,
});

Response

{
  "webhookSubscriptions": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/WebhookSubscription/892403750",
          "topic": "ORDERS_CANCELLED",
          "uri": "https://example.org/fully_loaded_1"
        }
      },
      {
        "node": {
          "id": "gid://shopify/WebhookSubscription/901431826",
          "topic": "APP_UNINSTALLED",
          "uri": "https://apple.com/uninstall"
        }
      }
    ]
  }
}

Get the first two webhook subscriptions with an APP_UNINSTALLED topic

Query

query {
  webhookSubscriptions(first: 2, topics: APP_UNINSTALLED) {
    edges {
      node {
        id
        topic
        uri
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscriptions(first: 2, topics: APP_UNINSTALLED) { edges { node { id topic uri } } } }"
}'

Remix

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    webhookSubscriptions(first: 2, topics: APP_UNINSTALLED) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }`,
);

const data = await response.json();

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    webhookSubscriptions(first: 2, topics: APP_UNINSTALLED) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscriptions(first: 2, topics: APP_UNINSTALLED) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }`,
});

Response

{
  "webhookSubscriptions": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/WebhookSubscription/901431826",
          "topic": "APP_UNINSTALLED",
          "uri": "https://apple.com/uninstall"
        }
      },
      {
        "node": {
          "id": "gid://shopify/WebhookSubscription/1014196360",
          "topic": "APP_UNINSTALLED",
          "uri": "https://example.org/app_uninstalled"
        }
      }
    ]
  }
}

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

webhookSubscriptions(first: 2) {

edges {

node {

topic

uri

}

}`,

);

const data = await response.json();

query {
  webhookSubscriptions(first: 2) {
    edges {
      node {
        id
        topic
        uri
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscriptions(first: 2) { edges { node { id topic uri } } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          uri
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"webhookSubscriptions": {

"edges": [

{

"node": {

"id": "gid://shopify/WebhookSubscription/892403750",

"topic": "ORDERS_CANCELLED",

"uri": "https://example.org/fully_loaded_1"

}

{

"node": {

"id": "gid://shopify/WebhookSubscription/901431826",

"topic": "APP_UNINSTALLED",

"uri": "https://apple.com/uninstall"

}

]

}