Anchor to section titled 'undefined'

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 section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The ID of the WebhookSubscription to return.

Was this section helpful?
Anchor to section titled 'WebhookSubscription possible returns'

WebhookSubscription possible returns

Anchor to WebhookSubscription
WebhookSubscription
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

Hide code
Copy
query {
  webhookSubscription(id: "gid://shopify/WebhookSubscription/892403750") {
    id
    topic
    endpoint {
      __typename
      ... on WebhookHttpEndpoint {
        callbackUrl
      }
      ... on WebhookEventBridgeEndpoint {
        arn
      }
    }
  }
}
Hide code
Response
JSON
{
  "webhookSubscription": {
    "id": "gid://shopify/WebhookSubscription/892403750",
    "topic": "ORDERS_CANCELLED",
    "endpoint": {
      "__typename": "WebhookHttpEndpoint",
      "callbackUrl": "https://example.org/fully_loaded_1"
    }
  }
}