webhookSubscriptionCreate mutation

Creates a new webhook subscription.

On this page

• Interactive example
• Arguments
• WebhookSubscriptionInput fields
• Return fields

Interactive example

This is an example mutation query.

<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">webhookSubscription</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>

Arguments

WebhookSubscriptionInput fields

• callbackUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
  URL where the webhook subscription should send the POST request when the event occurs.
• format ([WebhookSubscriptionFormat](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionformat))
  The format in which the webhook subscription should send the data.
• includeFields ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The list of fields to be included in the webhook subscription.
• metafieldNamespaces ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The list of namespaces for any metafields that should be included in the webhook subscription.

Return fields

• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.
• webhookSubscription ([WebhookSubscription](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscription))
  The webhook subscription that was created.