Anchor to pubSubWebhookSubscriptionUpdatepub
pubSubWebhookSubscriptionUpdate
mutation
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 Arguments
Arguments
- •ID!required
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhook•
Subscription Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.
Was this section helpful?
Anchor to PubSubWebhookSubscriptionUpdatePayload returnsPubSubWebhookSubscriptionUpdatePayload returns
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•
Subscription The webhook subscription that was updated.
Was this section helpful?
- Update a webhook subscription from HTTP to Google Pub/Sub
- pubSubWebhookSubscriptionUpdate reference
Examples
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",
mutation pubSubWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: PubSubWebhookSubscriptionInput!) {
pubSubWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
userErrors {
field
message
}
webhookSubscription {
id
topic
endpoint {
... on WebhookPubSubEndpoint {
pubSubProject
pubSubTopic
}
}
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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"
}
}
}'
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 data = await response.json();
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"
}
},
},
});
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)
Input variables
JSON{
"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"
}
}
}
}