Anchor to section titled 'undefined'pub
pub
mutation
2024-04
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.
Anchor to section titled 'Arguments'
Arguments
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhookSubscription
Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.
Was this section helpful?
Anchor to section titled 'PubSubWebhookSubscriptionUpdatePayload returns'
PubSubWebhookSubscriptionUpdatePayload returns
The list of errors that occurred from executing the mutation.
The webhook subscription that was updated.
Was this section helpful?
Code examples for MUTATION: pubSubWebhookSubscriptionUpdate
Query Reference for MUTATION: pubSubWebhookSubscriptionUpdate
"mutation pubSubWebhookSubscriptionUpdate($id: ID!) {\n pubSubWebhookSubscriptionUpdate(id: $id) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n # WebhookSubscription fields\n }\n }\n}"Input Reference for MUTATION: pubSubWebhookSubscriptionUpdate
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"webhookSubscription\": {\n \"format\": \"JSON\",\n \"includeFields\": [\n \"<your-includeFields>\"\n ],\n \"metafieldNamespaces\": [\n \"<your-metafieldNamespaces>\"\n ],\n \"pubSubProject\": \"<your-pubSubProject>\",\n \"pubSubTopic\": \"<your-pubSubTopic>\"\n }\n}"Schema Reference for MUTATION: pubSubWebhookSubscriptionUpdate
"input PubSubWebhookSubscriptionInput {\n format: WebhookSubscriptionFormat\n includeFields: [String!]\n metafieldNamespaces: [String!]\n pubSubProject: String!\n pubSubTopic: String!\n}\n"Display Examples for MUTATION: pubSubWebhookSubscriptionUpdate
[
{
"example": {
"type_name": "pubsubwebhooksubscriptionupdate",
"title": "Update a webhook subscription from HTTP to Google Pub/Sub",
"query_string": "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}",
"variables": {
"id": "gid://shopify/WebhookSubscription/525699895",
"webhookSubscription": {
"pubSubProject": "a-gcp-project",
"pubSubTopic": "a-pubsub-topic",
"format": "JSON"
}
},
"response": {
"data": {
"pubSubWebhookSubscriptionUpdate": {
"userErrors": [],
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/525699895",
"topic": "ORDERS_CREATE",
"endpoint": {
"pubSubProject": "a-gcp-project",
"pubSubTopic": "a-pubsub-topic"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/pub_sub_webhook_subscription_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\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$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the webhook subscription to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/WebhookSubscription/525699895\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "webhookSubscription",
"description": "Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PubSubWebhookSubscriptionInput",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "PubSubWebhookSubscriptionInput",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"pubSubProject\":\"a-gcp-project\",\"pubSubTopic\":\"a-pubsub-topic\",\"format\":\"JSON\"}",
"typeKind": "MUTATION"
}
]
}
]