Anchor to section titled 'undefined'pub
pub
mutation
Unstable
Creates a new 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 type of event that triggers the webhook.
Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.
Was this section helpful?
Anchor to section titled 'PubSubWebhookSubscriptionCreatePayload returns'
PubSubWebhookSubscriptionCreatePayload returns
The list of errors that occurred from executing the mutation.
The webhook subscription that was created.
Was this section helpful?
Code examples for MUTATION: pubSubWebhookSubscriptionCreate
Query Reference for MUTATION: pubSubWebhookSubscriptionCreate
"mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n # WebhookSubscription fields\n }\n }\n}"Input Reference for MUTATION: pubSubWebhookSubscriptionCreate
"{\n \"topic\": \"APP_PURCHASES_ONE_TIME_UPDATE\",\n \"webhookSubscription\": {\n \"filter\": \"<your-filter>\",\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: pubSubWebhookSubscriptionCreate
"input PubSubWebhookSubscriptionInput {\n filter: String\n format: WebhookSubscriptionFormat\n includeFields: [String!]\n metafieldNamespaces: [String!]\n pubSubProject: String!\n pubSubTopic: String!\n}\n"Display Examples for MUTATION: pubSubWebhookSubscriptionCreate
[
{
"example": {
"type_name": "pubsubwebhooksubscriptioncreate",
"title": "Create a Google Cloud Pub/Sub webhook subscription for ORDERS_CREATE events",
"query_string": "mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n}",
"variables": {
"topic": "ORDERS_CREATE",
"webhookSubscription": {
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-topic",
"format": "JSON"
}
},
"response": {
"data": {
"pubSubWebhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084096",
"topic": "ORDERS_CREATE",
"format": "JSON",
"endpoint": {
"__typename": "WebhookPubSubEndpoint",
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-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_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"ORDERS_CREATE\",\n \"webhookSubscription\" => [\n \"pubSubProject\" => \"my-gcp-project\",\n \"pubSubTopic\" => \"my-gcp-topic\",\n \"format\" => \"JSON\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"ORDERS_CREATE\"",
"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": true
},
"defaultValue": null,
"typeSignature": "PubSubWebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"pubSubProject\":\"my-gcp-project\",\"pubSubTopic\":\"my-gcp-topic\",\"format\":\"JSON\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "pubsubwebhooksubscriptioncreate",
"title": "Create a METAOBJECTS_CREATE Pub/Sub webhook subscription for lookbook metaobjects",
"query_string": "mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"topic": "METAOBJECTS_CREATE",
"webhookSubscription": {
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-topic",
"format": "JSON",
"filter": "type:lookbook"
}
},
"response": {
"data": {
"pubSubWebhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084097",
"topic": "METAOBJECTS_CREATE",
"filter": "type:lookbook",
"format": "JSON",
"endpoint": {
"__typename": "WebhookPubSubEndpoint",
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-topic"
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-07",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/pub_sub_webhook_subscription_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic filter format endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } userErrors { field message } } }\",\n \"variables\": {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"METAOBJECTS_CREATE\",\n \"webhookSubscription\" => [\n \"pubSubProject\" => \"my-gcp-project\",\n \"pubSubTopic\" => \"my-gcp-topic\",\n \"format\" => \"JSON\",\n \"filter\" => \"type:lookbook\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"METAOBJECTS_CREATE\"",
"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": true
},
"defaultValue": null,
"typeSignature": "PubSubWebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"pubSubProject\":\"my-gcp-project\",\"pubSubTopic\":\"my-gcp-topic\",\"format\":\"JSON\",\"filter\":\"type:lookbook\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "pubsubwebhooksubscriptioncreate",
"title": "Create an ORDERS_CREATE Pub/Sub webhook subscription that includes metafields during serialization",
"query_string": "mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n}",
"variables": {
"topic": "ORDERS_CREATE",
"webhookSubscription": {
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-topic",
"format": "JSON",
"metafieldNamespaces": [
"MY_NAMESPACE",
"ANOTHER_NAMESPACE"
]
}
},
"response": {
"data": {
"pubSubWebhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084098",
"topic": "ORDERS_CREATE",
"format": "JSON",
"metafieldNamespaces": [
"MY_NAMESPACE",
"ANOTHER_NAMESPACE"
],
"endpoint": {
"__typename": "WebhookPubSubEndpoint",
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-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_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format metafieldNamespaces endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ]\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\"MY_NAMESPACE\", \"ANOTHER_NAMESPACE\"]\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ]\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"ORDERS_CREATE\",\n \"webhookSubscription\" => [\n \"pubSubProject\" => \"my-gcp-project\",\n \"pubSubTopic\" => \"my-gcp-topic\",\n \"format\" => \"JSON\",\n \"metafieldNamespaces\" => [\"MY_NAMESPACE\", \"ANOTHER_NAMESPACE\"],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"ORDERS_CREATE\"",
"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": true
},
"defaultValue": null,
"typeSignature": "PubSubWebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"pubSubProject\":\"my-gcp-project\",\"pubSubTopic\":\"my-gcp-topic\",\"format\":\"JSON\",\"metafieldNamespaces\":[\"MY_NAMESPACE\",\"ANOTHER_NAMESPACE\"]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "pubsubwebhooksubscriptioncreate",
"title": "Create an ORDERS_CREATE Pub/Sub webhook subscription with fewer resource fields",
"query_string": "mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n}",
"variables": {
"topic": "ORDERS_CREATE",
"webhookSubscription": {
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-topic",
"format": "JSON",
"includeFields": [
"id",
"note"
]
}
},
"response": {
"data": {
"pubSubWebhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084095",
"topic": "ORDERS_CREATE",
"format": "JSON",
"includeFields": [
"id",
"note"
],
"endpoint": {
"__typename": "WebhookPubSubEndpoint",
"pubSubProject": "my-gcp-project",
"pubSubTopic": "my-gcp-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_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format includeFields endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ]\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"includeFields\": [\"id\", \"note\"]\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"pubSubProject\": \"my-gcp-project\",\n \"pubSubTopic\": \"my-gcp-topic\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ]\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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {\n pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookPubSubEndpoint {\n pubSubProject\n pubSubTopic\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"ORDERS_CREATE\",\n \"webhookSubscription\" => [\n \"pubSubProject\" => \"my-gcp-project\",\n \"pubSubTopic\" => \"my-gcp-topic\",\n \"format\" => \"JSON\",\n \"includeFields\" => [\"id\", \"note\"],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"ORDERS_CREATE\"",
"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": true
},
"defaultValue": null,
"typeSignature": "PubSubWebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"pubSubProject\":\"my-gcp-project\",\"pubSubTopic\":\"my-gcp-topic\",\"format\":\"JSON\",\"includeFields\":[\"id\",\"note\"]}",
"typeKind": "MUTATION"
}
]
}
]