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.

WebhookSubscriptionInput

Version 2019-04

Specifies the input fields for a webhook subscription.

Show definition
"""
Specifies the input fields for a webhook subscription.
"""
input WebhookSubscriptionInput {
  """
  URL where the webhook subscription should send the POST request when the event occurs.
  """
  callbackUrl: URL
  """
  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!]
}

Input Fields

callbackUrl (URL)

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

format (WebhookSubscriptionFormat)

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

includeFields ([String!])

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

metafieldNamespaces ([String!])

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

Version 2019-07 (Latest)

Specifies the input fields for a webhook subscription.

Show definition
"""
Specifies the input fields for a webhook subscription.
"""
input WebhookSubscriptionInput {
  """
  URL where the webhook subscription should send the POST request when the event occurs.
  """
  callbackUrl: URL
  """
  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!]
}

Input Fields

callbackUrl (URL)

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

format (WebhookSubscriptionFormat)

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

includeFields ([String!])

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

metafieldNamespaces ([String!])

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

Version 2019-10 (Release candidate)

Specifies the input fields for a webhook subscription.

Show definition
"""
Specifies the input fields for a webhook subscription.
"""
input WebhookSubscriptionInput {
  """
  URL where the webhook subscription should send the POST request when the event occurs.
  """
  callbackUrl: URL
  """
  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!]
}

Input Fields

callbackUrl (URL)

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

format (WebhookSubscriptionFormat)

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

includeFields ([String!])

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

metafieldNamespaces ([String!])

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

Sign up for a Partner account to get started.

Sign up