Choose a version:

WebhookSubscriptionInput

input_object

The input fields for a webhook subscription.

Anchor to FieldsFields

Anchor to callbackUrlcallbackUrl •URL: URL where the webhook subscription should send the POST request when the event occurs.
Anchor to filterfilter •String: A constraint specified using search syntax that ensures only webhooks that match the specified filter are emitted. See our guide on filters for more details.
Anchor to formatformat •WebhookSubscriptionFormat: The format in which the webhook subscription should send the data.
Anchor to includeFieldsincludeFields •[String!]: The list of fields to be included in the webhook subscription. Only the fields specified will be included in the webhook payload. If null, then all fields will be included. Learn more about modifying webhook payloads.
Anchor to metafieldNamespacesmetafieldNamespaces •[String!]: The list of namespaces for any metafields that should be included in the webhook subscription.
Anchor to metafieldsmetafields •[HasMetafieldsMetafieldIdentifierInput!]: A list of identifiers specifying metafields to include in the webhook payload.

Was this section helpful?

Anchor to webhookSubscriptionCreate.webhookSubscription webhookSubscriptionCreate.webhookSubscription •MUTATION
Anchor to webhookSubscriptionUpdate.webhookSubscription webhookSubscriptionUpdate.webhookSubscription •MUTATION

Was this section helpful?