pubSubWebhookSubscriptionCreate

mutation

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.

Arguments

Anchor to topictopic • WebhookSubscriptionTopic!required: The type of event that triggers the webhook.
Anchor to webhookSubscriptionwebhookSubscription • PubSubWebhookSubscriptionInput!required: Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.
Anchor to subTopicsubTopic • StringDeprecated: An additional constraint to refine the type of event that triggers the webhook. Only supported on certain topics. See our guide to sub-topics for more. Use webhookSubscription.filter instead.

Was this section helpful?

Anchor to PubSubWebhookSubscriptionCreatePayload returnsPubSubWebhookSubscriptionCreatePayload returns

Anchor to userErrorsuserErrors • [PubSubWebhookSubscriptionCreateUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to webhookSubscriptionwebhookSubscription • WebhookSubscription: The webhook subscription that was created.

Was this section helpful?

Create a Google Cloud Pub/Sub webhook subscription for ORDERS_CREATE events
Create an ORDERS_CREATE Pub/Sub webhook subscription that includes metafields during serialization
Create an ORDERS_CREATE Pub/Sub webhook subscription with fewer resource fields
pubSubWebhookSubscriptionCreate reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {

pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {

webhookSubscription {

topic

format

endpoint {

__typename

... on WebhookPubSubEndpoint {

pubSubProject

pubSubTopic

}

userErrors {

field

message

}

}`,

{

variables: {

mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {
  pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {
    webhookSubscription {
      id
      topic
      format
      endpoint {
        __typename
        ... on WebhookPubSubEndpoint {
          pubSubProject
          pubSubTopic
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } }",
 "variables": {
    "topic": "ORDERS_CREATE",
    "webhookSubscription": {
      "pubSubProject": "my-gcp-project",
      "pubSubTopic": "my-gcp-topic",
      "format": "JSON"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {
    pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {
      webhookSubscription {
        id
        topic
        format
        endpoint {
          __typename
          ... on WebhookPubSubEndpoint {
            pubSubProject
            pubSubTopic
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "topic": "ORDERS_CREATE",
      "webhookSubscription": {
        "pubSubProject": "my-gcp-project",
        "pubSubTopic": "my-gcp-topic",
        "format": "JSON"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "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
        }
      }
    }`,
    "variables": {
      "topic": "ORDERS_CREATE",
      "webhookSubscription": {
        "pubSubProject": "my-gcp-project",
        "pubSubTopic": "my-gcp-topic",
        "format": "JSON"
      }
    },
  },
});

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 pubSubWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {
    pubSubWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {
      webhookSubscription {
        id
        topic
        format
        endpoint {
          __typename
          ... on WebhookPubSubEndpoint {
            pubSubProject
            pubSubTopic
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "topic": "ORDERS_CREATE",
  "webhookSubscription": {
    "pubSubProject": "my-gcp-project",
    "pubSubTopic": "my-gcp-topic",
    "format": "JSON"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"topic": "ORDERS_CREATE",

"webhookSubscription": {

"pubSubProject": "my-gcp-project",

"pubSubTopic": "my-gcp-topic",

"format": "JSON"

}

Response

JSON

{

"pubSubWebhookSubscriptionCreate": {

"webhookSubscription": {

"id": "gid://shopify/WebhookSubscription/8589934664",

"topic": "ORDERS_CREATE",

"format": "JSON",

"endpoint": {

"__typename": "WebhookPubSubEndpoint",

"pubSubProject": "my-gcp-project",

"pubSubTopic": "my-gcp-topic"

}

"userErrors": []

}