Skip to main content

Page

Requires one of the read_content or read_online_store_pages access scopes.

Subscribe to field-level changes on the Page GraphQL Admin API object. You can subscribe to create, delete, and update events, as well as changes to specific fields.

Each topic corresponds to a commerce resource that can exist independently within its domain. Child entities that depend on a parent within the same domain don't have their own topic. Instead, changes to child entities trigger a delivery on the parent topic. Calculated fields, derived fields, auto-updated timestamps, and cross-domain fields aren't available as triggers.

shopify.app.toml

[events]
api_version = "unstable"

[[events.subscription]]
handle = "my_page_event"

topic = "Page"
actions = ["update"]
triggers = ["page.body"]

uri = "https://your-app.com/events"

query = """
query page_event_payload($pageId: ID!) {
page(id: $pageId) {
id
title
handle
body
}
}
"""

Anchor to Supported triggersSupported triggers

Field-level triggers for Page subscriptions.

All triggers require one of the read_content or read_online_store_pages access scopes. Those triggers that require additional scopes are documented where relevant. Deprecated triggers are listed last.

Subscriptions can include multiple triggers. Use the shopify-webhook-id header for deduplication when handling duplicate deliveries.

Custom queries aren't limited to Page. They can query the full GraphQL Admin API.

Anchor to list-of-topics-page.*
page.*

Fires when events involve the Page object.

The "create" and "delete" actions are only relevant within the context of this parent topic. Use fields_changed to follow or replicate impacted data after a delete event. Define a custom query to retrieve specific fields from create events.

page.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under page, including nested triggers. Use a more specific trigger to limit events to the fields you need.

Variables: pageId

Anchor to list-of-topics-page.body
page.body

Fires when the body field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The body field represents the text content of the page, complete with HTML markup.

Variables: pageId

Anchor to list-of-topics-page.bodySummary
page.bodySummary

Fires when the bodySummary field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The bodySummary field represents the first 150 characters of the page body.

Variables: pageId

Anchor to list-of-topics-page.handle
page.handle

Fires when the handle field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The handle field represents a unique, human-friendly string for the page.

Variables: pageId

Anchor to list-of-topics-page.isPublished
page.isPublished

Fires when the isPublished field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The isPublished field indicates whether or not the page is visible.

Variables: pageId

Anchor to list-of-topics-page.metafield(namespace: String!, key: String!).*
page.metafield(namespace: String!, key: String!).*

Fires when the metafield field on the Page object changes.

page.metafield(namespace: String!, key: String!).* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under page.metafield(namespace: String!, key: String!), including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Variables: metafieldKey, metafieldNamespace, pageId

Anchor to list-of-topics-page.metafield(namespace: String!).*
page.metafield(namespace: String!).*

Fires when the metafield field on the Page object changes.

page.metafield(namespace: String!).* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under page.metafield(namespace: String!), including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

This subscription omits the optional argument metafield.key.

The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Variables: metafieldKey, metafieldNamespace, pageId

Anchor to list-of-topics-page.metafield(namespace: String!, key: String!).value
page.metafield(namespace: String!, key: String!).value

Fires when the value field on the Metafield object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The value field represents the data stored in the metafield.

Variables: metafieldKey, metafieldNamespace, pageId

Anchor to list-of-topics-page.metafield(namespace: String!).value
page.metafield(namespace: String!).value

Fires when the value field on the Metafield object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

This subscription omits the optional argument metafield.key.

The value field represents the data stored in the metafield.

Variables: metafieldKey, metafieldNamespace, pageId

Anchor to list-of-topics-page.publishedAt
page.publishedAt

Fires when the publishedAt field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The publishedAt field represents the date and time (ISO 8601 format) when the page became or will become visible.

Variables: pageId

Anchor to list-of-topics-page.templateSuffix
page.templateSuffix

Fires when the templateSuffix field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The templateSuffix field represents the suffix of the template that's used to render the page.

Variables: pageId

Anchor to list-of-topics-page.title
page.title

Fires when the title field on the Page object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

Title of the page.

Variables: pageId

Was this page helpful?