We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

WebhookSubscription

Version 2019-04

Represents a subscription to a webhook.

Show definition
"""
Represents a subscription to a webhook.
"""
type WebhookSubscription implements LegacyInteroperability & Node {
  """
  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!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The list of fields to be included in the webhook subscription.
  """
  includeFields: [String!]!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  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.

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

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

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

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

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

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

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Version 2019-07 (Latest)

Represents a subscription to a webhook.

Show definition
"""
Represents a subscription to a webhook.
"""
type WebhookSubscription implements LegacyInteroperability & Node {
  """
  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!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The list of fields to be included in the webhook subscription.
  """
  includeFields: [String!]!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  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.

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

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

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

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

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

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

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Version 2019-10 (Release candidate)

Represents a subscription to a webhook.

Show definition
"""
Represents a subscription to a webhook.
"""
type WebhookSubscription implements LegacyInteroperability & Node {
  """
  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!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The list of fields to be included in the webhook subscription.
  """
  includeFields: [String!]!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  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.

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

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

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

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

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

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

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Sign up for a Partner account to get started.

Sign up