# pubSubWebhookSubscriptionCreate - admin-graphql - MUTATION Version: 2024-10 ## Description 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](https://shopify.dev/docs/apps/build/webhooks/subscribe). ### Access Scopes ## Arguments * [topic](/docs/api/admin-graphql/2024-10/enums/WebhookSubscriptionTopic): WebhookSubscriptionTopic! - The type of event that triggers the webhook. * [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/PubSubWebhookSubscriptionCreateUserError): PubSubWebhookSubscriptionCreateUserError! 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 created. ## Examples ### Create a Google Cloud Pub/Sub webhook subscription for ORDERS_CREATE events 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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } userErrors { field message } } }\",\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" 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 userErrors {\n field\n message\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" 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 userErrors {\n field\n message\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" 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 userErrors {\n field\n message\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" Graphql 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 userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "ORDERS_CREATE", "webhookSubscription": { "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic", "format": "JSON" } } #### Graphql Response { "data": { "pubSubWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934664", "topic": "ORDERS_CREATE", "format": "JSON", "endpoint": { "__typename": "WebhookPubSubEndpoint", "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic" } }, "userErrors": [] } } } ### Create a METAOBJECTS_CREATE Pub/Sub webhook subscription for lookbook metaobjects 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 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" 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" 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" 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" Graphql 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}" #### Graphql Input { "topic": "METAOBJECTS_CREATE", "webhookSubscription": { "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic", "format": "JSON", "filter": "type:lookbook" } } #### Graphql Response { "data": { "pubSubWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934655", "topic": "METAOBJECTS_CREATE", "filter": "type:lookbook", "format": "JSON", "endpoint": { "__typename": "WebhookPubSubEndpoint", "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic" } }, "userErrors": [] } } } ### Create an ORDERS_CREATE Pub/Sub webhook subscription that includes metafields during serialization 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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format metafieldNamespaces endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } userErrors { field message } } }\",\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" 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 userErrors {\n field\n message\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" 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 userErrors {\n field\n message\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" 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 userErrors {\n field\n message\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" Graphql 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 userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "ORDERS_CREATE", "webhookSubscription": { "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic", "format": "JSON", "metafieldNamespaces": [ "MY_NAMESPACE", "ANOTHER_NAMESPACE" ] } } #### Graphql Response { "data": { "pubSubWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934658", "topic": "ORDERS_CREATE", "format": "JSON", "metafieldNamespaces": [ "MY_NAMESPACE", "ANOTHER_NAMESPACE" ], "endpoint": { "__typename": "WebhookPubSubEndpoint", "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic" } }, "userErrors": [] } } } ### Create an ORDERS_CREATE Pub/Sub webhook subscription with fewer resource fields 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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) { pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format includeFields endpoint { __typename ... on WebhookPubSubEndpoint { pubSubProject pubSubTopic } } } userErrors { field message } } }\",\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" 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 userErrors {\n field\n message\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" 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 userErrors {\n field\n message\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" 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 userErrors {\n field\n message\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" Graphql 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 userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "ORDERS_CREATE", "webhookSubscription": { "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic", "format": "JSON", "includeFields": [ "id", "note" ] } } #### Graphql Response { "data": { "pubSubWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934662", "topic": "ORDERS_CREATE", "format": "JSON", "includeFields": [ "id", "note" ], "endpoint": { "__typename": "WebhookPubSubEndpoint", "pubSubProject": "my-gcp-project", "pubSubTopic": "my-gcp-topic" } }, "userErrors": [] } } }