API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

WebhookSubscriptionInput input object

Version unstable

Specifies the input fields for a webhook subscription.

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 2021-04 (Release candidate)

Specifies the input fields for a webhook subscription.

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 2021-01 (Latest)

Specifies the input fields for a webhook subscription.

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 2020-10

Specifies the input fields for a webhook subscription.

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 2020-07

Specifies the input fields for a webhook subscription.

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 2020-04

Specifies the input fields for a webhook subscription.

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 2020-01 (Unsupported)

Specifies the input fields for a webhook subscription.

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 (Unsupported)

Specifies the input fields for a webhook subscription.

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 (Unsupported)

Specifies the input fields for a webhook subscription.

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-04 (Unsupported)

Specifies the input fields for a webhook subscription.

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.