webhookSubscriptionCreate mutation

Version 2020-01 (Release candidate)

Creates a new webhook subscription.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

topic ( WebhookSubscriptionTopic! ) required

The type of event that triggers the webhook.

webhookSubscription ( WebhookSubscriptionInput! ) required

Specifies the input fields for a webhook subscription.

WebhookSubscriptionInput 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.

Return fields

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

webhookSubscription (WebhookSubscription)

The webhook subscription that was created.

Version 2019-10 (Latest)

Creates a new webhook subscription.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

topic ( WebhookSubscriptionTopic! ) required

The type of event that triggers the webhook.

webhookSubscription ( WebhookSubscriptionInput! ) required

Specifies the input fields for a webhook subscription.

WebhookSubscriptionInput 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.

Return fields

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

webhookSubscription (WebhookSubscription)

The webhook subscription that was created.

Version 2019-07

Creates a new webhook subscription.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

topic ( WebhookSubscriptionTopic! ) required

The type of event that triggers the webhook.

webhookSubscription ( WebhookSubscriptionInput! ) required

Specifies the input fields for a webhook subscription.

WebhookSubscriptionInput 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.

Return fields

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

webhookSubscription (WebhookSubscription)

The webhook subscription that was created.

Version 2019-04

Creates a new webhook subscription.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

topic ( WebhookSubscriptionTopic! ) required

The type of event that triggers the webhook.

webhookSubscription ( WebhookSubscriptionInput! ) required

Specifies the input fields for a webhook subscription.

WebhookSubscriptionInput 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.

Return fields

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

webhookSubscription (WebhookSubscription)

The webhook subscription that was created.

Sign up for a Partner account to get started.

Sign up