webhookSubscriptionUpdate mutation

Updates a webhook subscription.

On this page

Interactive example

This is an example mutation query.

mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { 
  1. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">field</font>
  5.   <font style="color:#1F61A0;">message</font>
  7. <font style="color:#555555;">}</font>
  9. <font style="color:#1F61A0;">webhookSubscription</font> <font style="color:#555555;">{</font>
  11.   <font style="color:#1F61A0;">id</font>
  13. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “webhookSubscription”: {} }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the webhook subscription to update.
webhookSubscription
(
[WebhookSubscriptionInput!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptioninput)

) REQUIRED		 Specifies the input fields for a webhook subscription.

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