--- title: pubSubWebhookSubscriptionUpdate - GraphQL Admin 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). api_version: unstable api_name: admin source_url: html: >- https://shopify.dev/docs/api/admin-graphql/unstable/mutations/pubSubWebhookSubscriptionUpdate md: >- https://shopify.dev/docs/api/admin-graphql/unstable/mutations/pubSubWebhookSubscriptionUpdate.md --- # pub​Sub​Webhook​Subscription​Update mutation Deprecated. Use [webhookSubscriptionUpdate](https://shopify.dev/docs/api/admin-graphql/latest/mutations/webhookSubscriptionUpdate) instead. 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). ## Arguments * id [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID) required The ID of the webhook subscription to update. * webhook​Subscription [Pub​Sub​Webhook​Subscription​Input!](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/PubSubWebhookSubscriptionInput) required Specifies the input fields for a Google Cloud Pub/Sub webhook subscription. *** ## Pub​Sub​Webhook​Subscription​Update​Payload returns * user​Errors [\[Pub​Sub​Webhook​Subscription​Update​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/unstable/objects/PubSubWebhookSubscriptionUpdateUserError) non-null The list of errors that occurred from executing the mutation. * webhook​Subscription [Webhook​Subscription](https://shopify.dev/docs/api/admin-graphql/unstable/objects/WebhookSubscription) The webhook subscription that was updated. *** ## Examples * ### Update a webhook subscription from HTTP to Google Pub/Sub #### Query ```graphql mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } } ``` #### Variables ```json { "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } } ``` #### cURL ```bash curl -X POST \ https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }", "variables": { "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } } }' ``` #### React Router ```javascript import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }`, { variables: { "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } }, }, ); const json = await response.json(); return json.data; } ``` #### Ruby ```ruby session = ShopifyAPI::Auth::Session.new( shop: "your-development-store.myshopify.com", access_token: access_token ) client = ShopifyAPI::Clients::Graphql::Admin.new( session: session ) query = <<~QUERY mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } } QUERY variables = { "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }`, "variables": { "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } }, }, }); ``` #### Shopify CLI ```bash shopify app execute \ --query \ 'mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }' \ --variables \ '{ "id": "gid://shopify/WebhookSubscription/525699895", "webhookSubscription": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic", "format": "JSON" } }' ``` #### Response ```json { "pubSubWebhookSubscriptionUpdate": { "userErrors": [], "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/525699895", "topic": "ORDERS_CREATE", "endpoint": { "pubSubProject": "a-gcp-project", "pubSubTopic": "a-pubsub-topic" } } } } ``` * ### pubSubWebhookSubscriptionUpdate reference