webhookSubscriptionsCount - admin-graphql - QUERY

Version: 2024-10

Description:

The count 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](https://shopify.dev/docs/apps/build/webhooks/subscribe). Limited to a maximum of 10000.

Access Scopes

Arguments

• query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | created_at | time | | endpoint | string | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | topic | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

Returns

• count: Int! The count of elements.
• precision: CountPrecision! The count's precision, or the exactness of the value.

Examples

• Receive a count of all Webhooks

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query WebhookSubscriptionsCount($query: String!) { webhookSubscriptionsCount(query: $query) { count precision } }\",\n \"variables\": {\n    \"query\": \"topic:\\\"orders/create\\\"\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query WebhookSubscriptionsCount($query: String!) {\n      webhookSubscriptionsCount(query: $query) {\n        count\n        precision\n      }\n    }`,\n    \"variables\": {\n      \"query\": \"topic:\\\"orders/create\\\"\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query WebhookSubscriptionsCount($query: String!) {\n    webhookSubscriptionsCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY\n\nvariables = {\n  \"query\": \"topic:\"orders/create\"\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query WebhookSubscriptionsCount($query: String!) {\n    webhookSubscriptionsCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$variables = [\n  \"query\" => \"topic:\"orders/create\"\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query WebhookSubscriptionsCount($query: String!) {\n    webhookSubscriptionsCount(query: $query) {\n      count\n      precision\n    }\n  }`,\n  {\n    variables: {\n      \"query\": \"topic:\\\"orders/create\\\"\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query WebhookSubscriptionsCount($query: String!) {\n  webhookSubscriptionsCount(query: $query) {\n    count\n    precision\n  }\n}"
        

  input: {
    "query": "topic:\"orders/create\""
  }

  response: {
    "data": {
      "webhookSubscriptionsCount": {
        "count": 1,
        "precision": "EXACT"
      }
    }
  }