WebhookSubscription

Required access

read_false access scope

Represents a subscription to a webhook.

Show definition
# Represents a subscription to a webhook.
type WebhookSubscription implements Node {
  # Globally unique identifier.
  id: ID!

  # URL where the webhook subscription should send the POST request when the event occurs.
  callbackUrl: URL!

  # The date and time when the webhook subscription was created.
  createdAt: DateTime!

  # The format in which the webhook subscription should send the data.
  format: WebhookSubscriptionFormat!

  # The list of fields to be included in the webhook subscription.
  includeFields: [String!]!

  # The list of namespaces for any metafields that should be included in the webhook subscription.
  metafieldNamespaces: [String!]!

  # The type of event that triggers the webhook.
  topic: WebhookSubscriptionTopic!

  # The date and time when the webhook subscription was updated.
  updatedAt: DateTime!
}

Implements

Fields

callbackUrl   (URL!)

URL where the webhook subscription should send the POST request when the event occurs.

Required access

read_ access scope

createdAt   (DateTime!)

The date and time when the webhook subscription was created.

Required access

read_ access scope

format   (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

Required access

read_ access scope

id   (ID!)

Globally unique identifier.

Required access

read_ access scope

includeFields   ([String!]!)

The list of fields to be included in the webhook subscription.

Required access

read_ access scope

metafieldNamespaces   ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

Required access

read_ access scope

topic   (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

Required access

read_ access scope

updatedAt   (DateTime!)

The date and time when the webhook subscription was updated.

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up