WebhookSubscription object

Represents a subscription to a webhook.

On this page

Fields

  • createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the webhook subscription was created.
  • endpoint ([WebhookSubscriptionEndpoint!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionendpoint))
    Endpoint where webhooks will be delivered to.
  • format ([WebhookSubscriptionFormat!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionformat))
    The format in which the webhook subscription should send the data.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • includeFields ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The list of fields to be included in the webhook subscription.
  • legacyResourceId ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    The ID of the corresponding resource in the REST Admin API.
  • metafieldNamespaces ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The list of namespaces for any metafields that should be included in the webhook subscription.
  • topic ([WebhookSubscriptionTopic!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptiontopic))
    The type of event that triggers the webhook.
  • updatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

  • [QueryRoot.webhookSubscription](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#webhooksubscription-2021-01)
  • [QueryRoot.webhookSubscriptions](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#webhooksubscriptions-2021-01)

Mutations for WebhookSubscription

Implements

  • [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

  • callbackUrl ([URL!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)) DEPRECATED
    URL where the webhook subscription should send the POST request when the event occurs.
    Deprecation warning
    Use endpoint instead