Choose a version:

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 Arguments

Arguments

Anchor to idid •ID! required: The ID of the WebhookSubscription to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to WebhookSubscriptionWebhookSubscription •WebhookSubscription: 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.

Was this section helpful?

Examples

Get a single webhook subscription's ID, topic, and endpoint

Query

query {
  webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
    id
    topic
    endpoint {
      __typename
      ... on WebhookHttpEndpoint {
        callbackUrl
      }
      ... on WebhookEventBridgeEndpoint {
        arn
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscription(id: \"gid://shopify/WebhookSubscription/892403750\") { id topic endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } ... on WebhookEventBridgeEndpoint { arn } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      id
      topic
      endpoint {
        __typename
        ... on WebhookHttpEndpoint {
          callbackUrl
        }
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      id
      topic
      endpoint {
        __typename
        ... on WebhookHttpEndpoint {
          callbackUrl
        }
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      id
      topic
      endpoint {
        __typename
        ... on WebhookHttpEndpoint {
          callbackUrl
        }
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }`,
});

Response

{
  "webhookSubscription": {
    "id": "gid://shopify/WebhookSubscription/892403750",
    "topic": "ORDERS_CANCELLED",
    "endpoint": {
      "__typename": "WebhookHttpEndpoint",
      "callbackUrl": "https://example.org/fully_loaded_1"
    }
  }
}

Get a specific webhook subscription using the node field and a GraphQL fragment

Query

query {
  node(id: "gid://shopify/WebhookSubscription/892403750") {
    ... on WebhookSubscription {
      id
      createdAt
      updatedAt
      legacyResourceId
      topic
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { node(id: \"gid://shopify/WebhookSubscription/892403750\") { ... on WebhookSubscription { id createdAt updatedAt legacyResourceId topic } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    node(id: "gid://shopify/WebhookSubscription/892403750") {
      ... on WebhookSubscription {
        id
        createdAt
        updatedAt
        legacyResourceId
        topic
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    node(id: "gid://shopify/WebhookSubscription/892403750") {
      ... on WebhookSubscription {
        id
        createdAt
        updatedAt
        legacyResourceId
        topic
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    node(id: "gid://shopify/WebhookSubscription/892403750") {
      ... on WebhookSubscription {
        id
        createdAt
        updatedAt
        legacyResourceId
        topic
      }
    }
  }`,
});

Response

{
  "node": {
    "id": "gid://shopify/WebhookSubscription/892403750",
    "createdAt": "2021-12-01T10:23:43Z",
    "updatedAt": "2021-12-01T10:23:43Z",
    "legacyResourceId": "892403750",
    "topic": "ORDERS_CANCELLED"
  }
}

Get the dates a webhook subscription was created and updated

Query

query {
  webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
    createdAt
    updatedAt
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscription(id: \"gid://shopify/WebhookSubscription/892403750\") { createdAt updatedAt } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      createdAt
      updatedAt
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      createdAt
      updatedAt
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      createdAt
      updatedAt
    }
  }`,
});

Response

{
  "webhookSubscription": {
    "createdAt": "2021-12-01T10:23:43Z",
    "updatedAt": "2021-12-01T10:23:43Z"
  }
}

Get the topic of a webhook subscription

Query

query {
  webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
    topic
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscription(id: \"gid://shopify/WebhookSubscription/892403750\") { topic } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      topic
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      topic
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      topic
    }
  }`,
});

Response

{
  "webhookSubscription": {
    "topic": "ORDERS_CANCELLED"
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query {

webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {

topic

endpoint {

__typename

... on WebhookHttpEndpoint {

callbackUrl

}

... on WebhookEventBridgeEndpoint {

arn

}

}`,

);

const json = await response.json();

return json.data;

}

query {
  webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
    id
    topic
    endpoint {
      __typename
      ... on WebhookHttpEndpoint {
        callbackUrl
      }
      ... on WebhookEventBridgeEndpoint {
        arn
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { webhookSubscription(id: \"gid://shopify/WebhookSubscription/892403750\") { id topic endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } ... on WebhookEventBridgeEndpoint { arn } } } }"
}'

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      id
      topic
      endpoint {
        __typename
        ... on WebhookHttpEndpoint {
          callbackUrl
        }
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      id
      topic
      endpoint {
        __typename
        ... on WebhookHttpEndpoint {
          callbackUrl
        }
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }`,
});

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 {
    webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
      id
      topic
      endpoint {
        __typename
        ... on WebhookHttpEndpoint {
          callbackUrl
        }
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"webhookSubscription": {

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

"topic": "ORDERS_CANCELLED",

"endpoint": {

"__typename": "WebhookHttpEndpoint",

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

}