webhookSubscriptionUpdate - admin-graphql - MUTATION

Version: 2024-01

Description:

Updates a webhook subscription. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

Access Scopes

Arguments

• id: ID! - The ID of the webhook subscription to update.
• webhookSubscription: WebhookSubscriptionInput! - Specifies the input fields for a webhook subscription.

Returns

• userErrors: UserError! The list of errors that occurred from executing the mutation.
• webhookSubscription: WebhookSubscription The webhook subscription that was updated.

Examples

• Modify an existing Webhook

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation WebhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } ... on WebhookEventBridgeEndpoint { arn } ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } apiVersion { handle } format } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n    \"webhookSubscription\": {\n      \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation WebhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n      webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n        userErrors {\n          field\n          message\n        }\n        webhookSubscription {\n          id\n          topic\n          endpoint {\n            __typename\n            ... on WebhookHttpEndpoint {\n              callbackUrl\n            }\n            ... on WebhookEventBridgeEndpoint {\n              arn\n            }\n            ... on WebhookPubSubEndpoint {\n              pubSubProject\n              pubSubTopic\n            }\n          }\n          apiVersion {\n            handle\n          }\n          format\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n      \"webhookSubscription\": {\n        \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation WebhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n    webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n      userErrors {\n        field\n        message\n      }\n      webhookSubscription {\n        id\n        topic\n        endpoint {\n          __typename\n          ... on WebhookHttpEndpoint {\n            callbackUrl\n          }\n          ... on WebhookEventBridgeEndpoint {\n            arn\n          }\n          ... on WebhookPubSubEndpoint {\n            pubSubProject\n            pubSubTopic\n          }\n        }\n        apiVersion {\n          handle\n        }\n        format\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n  \"webhookSubscription\": {\n    \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation WebhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n    webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n      userErrors {\n        field\n        message\n      }\n      webhookSubscription {\n        id\n        topic\n        endpoint {\n          __typename\n          ... on WebhookHttpEndpoint {\n            callbackUrl\n          }\n          ... on WebhookEventBridgeEndpoint {\n            arn\n          }\n          ... on WebhookPubSubEndpoint {\n            pubSubProject\n            pubSubTopic\n          }\n        }\n        apiVersion {\n          handle\n        }\n        format\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/WebhookSubscription/525699895\",\n  \"webhookSubscription\" => [\n    \"callbackUrl\" => \"https://example.org/aValidEndpoint\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation WebhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n    webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n      userErrors {\n        field\n        message\n      }\n      webhookSubscription {\n        id\n        topic\n        endpoint {\n          __typename\n          ... on WebhookHttpEndpoint {\n            callbackUrl\n          }\n          ... on WebhookEventBridgeEndpoint {\n            arn\n          }\n          ... on WebhookPubSubEndpoint {\n            pubSubProject\n            pubSubTopic\n          }\n        }\n        apiVersion {\n          handle\n        }\n        format\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n      \"webhookSubscription\": {\n        \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation WebhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n  webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n    userErrors {\n      field\n      message\n    }\n    webhookSubscription {\n      id\n      topic\n      endpoint {\n        __typename\n        ... on WebhookHttpEndpoint {\n          callbackUrl\n        }\n        ... on WebhookEventBridgeEndpoint {\n          arn\n        }\n        ... on WebhookPubSubEndpoint {\n          pubSubProject\n          pubSubTopic\n        }\n      }\n      apiVersion {\n        handle\n      }\n      format\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/WebhookSubscription/525699895",
    "webhookSubscription": {
      "callbackUrl": "https://example.org/aValidEndpoint"
    }
  }

  response: {
    "data": {
      "webhookSubscriptionUpdate": {
        "userErrors": [],
        "webhookSubscription": {
          "id": "gid://shopify/WebhookSubscription/525699895",
          "topic": "ORDERS_CREATE",
          "endpoint": {
            "__typename": "WebhookHttpEndpoint",
            "callbackUrl": "https://example.org/aValidEndpoint"
          },
          "apiVersion": {
            "handle": "unstable"
          },
          "format": "XML"
        }
      }
    }
  }

  Update the callback URL of a webhook subscription

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookHttpEndpoint { callbackUrl } } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n    \"webhookSubscription\": {\n      \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n      webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n        userErrors {\n          field\n          message\n        }\n        webhookSubscription {\n          id\n          topic\n          endpoint {\n            ... on WebhookHttpEndpoint {\n              callbackUrl\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n      \"webhookSubscription\": {\n        \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n    webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n      userErrors {\n        field\n        message\n      }\n      webhookSubscription {\n        id\n        topic\n        endpoint {\n          ... on WebhookHttpEndpoint {\n            callbackUrl\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n  \"webhookSubscription\": {\n    \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n    webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n      userErrors {\n        field\n        message\n      }\n      webhookSubscription {\n        id\n        topic\n        endpoint {\n          ... on WebhookHttpEndpoint {\n            callbackUrl\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/WebhookSubscription/525699895\",\n  \"webhookSubscription\" => [\n    \"callbackUrl\" => \"https://example.org/aValidEndpoint\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n    webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n      userErrors {\n        field\n        message\n      }\n      webhookSubscription {\n        id\n        topic\n        endpoint {\n          ... on WebhookHttpEndpoint {\n            callbackUrl\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n      \"webhookSubscription\": {\n        \"callbackUrl\": \"https://example.org/aValidEndpoint\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation webhookSubscriptionUpdate($id: ID!, $webhookSubscription: WebhookSubscriptionInput!) {\n  webhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n    userErrors {\n      field\n      message\n    }\n    webhookSubscription {\n      id\n      topic\n      endpoint {\n        ... on WebhookHttpEndpoint {\n          callbackUrl\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/WebhookSubscription/525699895",
    "webhookSubscription": {
      "callbackUrl": "https://example.org/aValidEndpoint"
    }
  }

  response: {
    "data": {
      "webhookSubscriptionUpdate": {
        "userErrors": [],
        "webhookSubscription": {
          "id": "gid://shopify/WebhookSubscription/525699895",
          "topic": "ORDERS_CREATE",
          "endpoint": {
            "callbackUrl": "https://example.org/aValidEndpoint"
          }
        }
      }
    }
  }