PubSubWebhookSubscriptionInput - admin-graphql - INPUT_OBJECT

Version: 2024-10

Description:

The input fields for a PubSub webhook subscription.

Access Scopes

Fields

  • filter: String - A constraint specified using search syntax that ensures only webhooks that match the specified filter are emitted. See our [guide on filters](https://shopify.dev/docs/apps/build/webhooks/customize/filters) for more details.
  • 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.
  • pubSubProject: String! - The Pub/Sub project ID.
  • pubSubTopic: String! - The Pub/Sub topic ID.

Input objects with this input object

  • pubSubWebhookSubscriptionCreate
  • pubSubWebhookSubscriptionUpdate

Examples