# pubSubWebhookSubscriptionUpdate - admin-graphql - MUTATION Version: 2024-10 ## Description Updates a Google Cloud Pub/Sub 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](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - The ID of the webhook subscription to update. * [webhookSubscription](/docs/api/admin-graphql/2024-10/input-objects/PubSubWebhookSubscriptionInput): PubSubWebhookSubscriptionInput - Specifies the input fields for a Google Cloud Pub/Sub webhook subscription. ## Returns * [userErrors](/docs/api/admin-graphql/2024-10/objects/PubSubWebhookSubscriptionUpdateUserError): PubSubWebhookSubscriptionUpdateUserError! The list of errors that occurred from executing the mutation. * [webhookSubscription](/docs/api/admin-graphql/2024-10/objects/WebhookSubscription): WebhookSubscription The webhook subscription that was updated. ## Examples ### Update a webhook subscription from HTTP to Google Pub/Sub Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"a-gcp-project\",\n \"pubSubTopic\": \"a-pubsub-topic\",\n \"format\": \"JSON\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n id\n topic\n endpoint {\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"a-gcp-project\",\n \"pubSubTopic\": \"a-pubsub-topic\",\n \"format\": \"JSON\"\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 pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n id\n topic\n endpoint {\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"a-gcp-project\",\n \"pubSubTopic\": \"a-pubsub-topic\",\n \"format\": \"JSON\"\n }\n}\n\nresponse = 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 pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n id\n topic\n endpoint {\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/WebhookSubscription/525699895\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"a-gcp-project\",\n \"pubSubTopic\": \"a-pubsub-topic\",\n \"format\": \"JSON\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n id\n topic\n endpoint {\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } } #### Graphql Response { "data": { "pubSubWebhookSubscriptionUpdate": { "userErrors": [], "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/525699895", "topic": "ORDERS_CREATE", "endpoint": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic" } } } } }