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.

WebhookSubscriptionConnection arguments

•WebhookSubscriptionConnection!

after

•

String

The elements that come after the specified cursor.

before

•

String

The elements that come before the specified cursor.

callbackUrl

•

URL

Callback URL to filter by.

first

•

Int

The first n elements from the paginated list.

format

•

WebhookSubscriptionFormat

Response format to filter by.

last

•

Int

The last n elements from the paginated list.

query

•

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

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

WebhookSubscriptionSortKeysDefault: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.

topics

•

[WebhookSubscriptionTopic!]

List of webhook subscription topics to filter by.

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?

Get the IDs, topics, and endpoints of the first 2 webhook subscriptions
Get the first two webhook subscriptions with an APP_UNINSTALLED topic
Retrieves a list of webhooks

Examples

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

const response = await admin.graphql(

`#graphql

query {

webhookSubscriptions(first: 2) {

edges {

node {

topic

endpoint {

__typename

... on WebhookHttpEndpoint {

callbackUrl

}

... on WebhookEventBridgeEndpoint {

arn

}

... on WebhookPubSubEndpoint {

pubSubProject

pubSubTopic

}

}`,

);

const data = await response.json();

query {
  webhookSubscriptions(first: 2) {
    edges {
      node {
        id
        topic
        endpoint {
          __typename
          ... on WebhookHttpEndpoint {
            callbackUrl
          }
          ... on WebhookEventBridgeEndpoint {
            arn
          }
          ... on WebhookPubSubEndpoint {
            pubSubProject
            pubSubTopic
          }
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscriptions(first: 2) { edges { node { id topic endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } ... on WebhookEventBridgeEndpoint { arn } ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    webhookSubscriptions(first: 2) {
      edges {
        node {
          id
          topic
          endpoint {
            __typename
            ... on WebhookHttpEndpoint {
              callbackUrl
            }
            ... on WebhookEventBridgeEndpoint {
              arn
            }
            ... on WebhookPubSubEndpoint {
              pubSubProject
              pubSubTopic
            }
          }
        }
      }
    }
  }`,
);

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
          endpoint {
            __typename
            ... on WebhookHttpEndpoint {
              callbackUrl
            }
            ... on WebhookEventBridgeEndpoint {
              arn
            }
            ... on WebhookPubSubEndpoint {
              pubSubProject
              pubSubTopic
            }
          }
        }
      }
    }
  }`,
});

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
          endpoint {
            __typename
            ... on WebhookHttpEndpoint {
              callbackUrl
            }
            ... on WebhookEventBridgeEndpoint {
              arn
            }
            ... on WebhookPubSubEndpoint {
              pubSubProject
              pubSubTopic
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"webhookSubscriptions": {

"edges": [

{

"node": {

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

"topic": "ORDERS_CANCELLED",

"endpoint": {

"__typename": "WebhookHttpEndpoint",

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

}

{

"node": {

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

"topic": "APP_UNINSTALLED",

"endpoint": {

"__typename": "WebhookHttpEndpoint",

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

}

]

}