experiment_start_requested - XBOX Game Development Documentation

This event is triggered when an experiment is requested to start.

Properties

Name	Type	Description
Id	String	The unique identifier of the experiment.
Name	String	The friendly name of the experiment.
UsesOverrides	Boolean	Specifies whether the experiment uses title data overrides.
UsesExclusionGroup	Boolean	Specifies whether the experiment uses an exclusion group.
RequestOrigin	ExperimentRequestOrigin	The origin of the request to start the experiment.
Experiment	Experiment	The experiment configuration payload.

Common Properties

All V2 PlayStream events are formatted as JSON objects and most share the following common properties:

Name	Type	Description
SchemaVersion	String	PlayStream event format version, following a semantic versioning scheme.
FullName	Object	Combination of the event name and event namespace to fully specify the event type.
Id	String	PlayFab-assigned unique identifier for this event.
Timestamp	DateTime	The time (in UTC) associated with this event.
Entity	Object	Details about the entity to which this event applies including Entity Id and Entity type.
Originator	Object	Object describing the source and source type that initiated this event.
PayloadContentType	String	Specifies the content of the event payload. Default is “JSON”.
Origin Info	Object	Optional field containing info about events originating outside of PlayFab.

Last modified on August 1, 2026

Related topics

PlayStream event model reference for PlayFab experiment_stop_requested Experiment Manage Experiments Analyze Experiments

⌘I