Rollout
read_rollouts access scope.read_rollouts access scope.:Supported actions: create, update, delete
Subscribe to field-level changes on the Rollout GraphQL Admin API object.
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
Anchor to Supported triggersSupported triggers
Field-level triggers for Rollout subscriptions.
All triggers require the read_rollouts access scope. 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 Rollout. They can query the full GraphQL Admin API.
Fires when events involve the Rollout object.
The "create" and "delete" actions are only relevant within the context of this parent topic. Use to follow or replicate impacted data after a delete event. Define a custom query to retrieve specific fields from create events.
rollout.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under rollout, including nested triggers. Use a more specific trigger to limit events to the fields you need.
Variables:
Fires when the field on the Rollout 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 .
The field represents the actual conclusion date and time of the rollout for public API requests.
Variables:
Fires when the name field on the Rollout 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 .
The name field represents the name of the rollout.
Variables:
Fires when the schedule field on the Rollout 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 .
The schedule field represents the rollout's planned activation and conclusion dates.
Variables:
Fires when the field on the Rollout 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 .
The field represents the actual start date and time of the rollout for public API requests.
Variables:
Fires when the status field on the Rollout 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 .
The status field represents the status of the rollout.
Variables:
Fires when the field on the Rollout 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 .
The field represents the percentage of buyer traffic that the rollout is configured to receive, as an integer from 0 to 100.
Variables:
Fires when the treatments field on the Rollout object changes.
rollout.treatments.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under rollout.treatments, 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 .
The treatments field represents the treatments of the rollout.
Variables: ,
Fires when the changes field on the object changes.
rollout.treatments.changes.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under rollout.treatments.changes, 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 .
The changes field represents the changes this treatment makes to resources while it's served.
Variables: ,
Fires when the field on the interface changes.
is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under , 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 .
The field represents the outcome of the most recent attempt to apply this change to the store.
Variables: ,
Fires when the field on the 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 .
The field represents the date and time when applying the change finished, whether it succeeded or failed.
Variables: ,
Fires when the field on the 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 .
The field represents the reason the change couldn't be applied.
Variables: ,
Fires when the status field on the 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 .
The status field represents the status of applying the change.
Variables: ,