Skip to main content

Rollout

Requires 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

[events]
api_version = "unstable"

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

topic = "Rollout"
actions = ["update"]
triggers = ["rollout.concludedAt"]

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

query = """
query rollout_event_payload($rolloutId: ID!) {
rollout(id: $rolloutId) {
id
name
status
concludedAt
}
}
"""

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.

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

Fires when events involve the Rollout 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.

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: rolloutId

Anchor to list-of-topics-rollout.concludedAt
rollout.concludedAt

Fires when the concludedAt 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 fields_changed.

The concludedAt field represents the actual conclusion date and time of the rollout for public API requests.

Variables: rolloutId

Anchor to list-of-topics-rollout.name
rollout.name

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 fields_changed.

The name field represents the name of the rollout.

Variables: rolloutId

Anchor to list-of-topics-rollout.schedule
rollout.schedule

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 fields_changed.

The schedule field represents the rollout's planned activation and conclusion dates.

Variables: rolloutId

Anchor to list-of-topics-rollout.startedAt
rollout.startedAt

Fires when the startedAt 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 fields_changed.

The startedAt field represents the actual start date and time of the rollout for public API requests.

Variables: rolloutId

Anchor to list-of-topics-rollout.status
rollout.status

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 fields_changed.

The status field represents the status of the rollout.

Variables: rolloutId

Anchor to list-of-topics-rollout.trafficAllocation
rollout.trafficAllocation

Fires when the trafficAllocation 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 fields_changed.

The trafficAllocation field represents the percentage of buyer traffic that the rollout is configured to receive, as an integer from 0 to 100.

Variables: rolloutId

Anchor to list-of-topics-rollout.treatments.*
rollout.treatments.*

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 fields_changed.

The treatments field represents the treatments of the rollout.

Variables: rolloutId, treatmentsId

Anchor to list-of-topics-rollout.treatments.changes.*
rollout.treatments.changes.*

Fires when the changes field on the RolloutTreatment 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 fields_changed.

The changes field represents the changes this treatment makes to resources while it's served.

Variables: rolloutId, treatmentsId

Anchor to list-of-topics-rollout.treatments.changes.applyResult.*
rollout.treatments.changes.applyResult.*

Fires when the applyResult field on the RolloutChange interface changes.

rollout.treatments.changes.applyResult.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under rollout.treatments.changes.applyResult, 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 applyResult field represents the outcome of the most recent attempt to apply this change to the store.

Variables: rolloutId, treatmentsId

Anchor to list-of-topics-rollout.treatments.changes.applyResult.completedAt
rollout.treatments.changes.applyResult.completedAt

Fires when the completedAt field on the RolloutChangeApplyResult 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 completedAt field represents the date and time when applying the change finished, whether it succeeded or failed.

Variables: rolloutId, treatmentsId

Anchor to list-of-topics-rollout.treatments.changes.applyResult.errorCode
rollout.treatments.changes.applyResult.errorCode

Fires when the errorCode field on the RolloutChangeApplyResult 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 errorCode field represents the reason the change couldn't be applied.

Variables: rolloutId, treatmentsId

Anchor to list-of-topics-rollout.treatments.changes.applyResult.status
rollout.treatments.changes.applyResult.status

Fires when the status field on the RolloutChangeApplyResult 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 status field represents the status of applying the change.

Variables: rolloutId, treatmentsId


Was this page helpful?