Skip to main content

webhookSubscription

Loads a single WebhookSubscription by id.

Required scopes​

The token needs the webhook_subscriptions:read access scope.

webhookSubscription(
  id: ID!
): WebhookSubscription

Arguments​

webhookSubscription.id ● ID! non-null scalar​

Type​

WebhookSubscription object​

A request to be notified about a topic at a destination. Notifications carry only the ids of the affected entities and a timestamp; fetch the current state through the API. Subscriptions belong to the API token that created them: a token only sees and manages its own.

Delivery itself runs outside the shop, which is why every field from active through lastErrorMessage is a mirror of what the delivery service reports and is refreshed whenever the shop talks to it. A quiet shop's mirror can be up to a minute behind. Deliveries only start once the destination has consented, so a freshly created subscription reads consentState: Pending until then.