PlayStream event model reference for PlayFab

These are the built-in PlayStream events which are automatically generated by PlayFab Game Services APIs and written to the event pipeline. In addition to these events, you can create your own custom events using the WriteEvents API. Each event type has a set of properties that are included as part of event’s data wherever it’s sent. You can view these properties and build rules for triggering actions based on their values in the PlayStream tab of the Game Manager.

​

AdPlacement

• player_ad_closed
  This event is triggered when a player closes an ad.
• player_ad_ended
  This event is triggered when a player finishes an ad.
• player_ad_opened
  This event is triggered when a player opens an ad.
• player_ad_rewarded
  This event is triggered when a player receives an ad reward.
• player_ad_started
  This event is triggered when a player starts an ad.

​

Addons

• title_addon_changed
  This event is triggered when a title addon is changed.

​

ApiAccessPolicy

• title_api_settings_changed
  This event is triggered when an API Features setting is changed for the title.
• title_permission_policy_changed
  This event is triggered when an update occurs to a title’s permission policies.

​

CloudScript

• entity_executed_cloud_script
  This event is optionally triggered when an Entity CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the ‘Publish results as a PlayStream Event’ box checked.
• player_executed_cloudscript
  This event is optionally triggered when a CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the ‘Publish results as a PlayStream Event’ box checked.
• player_triggered_action_executed_cloudscript
  This event is triggered when a CloudScript function is run as the result of a PlayStream action, and the ‘Publish results as a PlayStream Event’ box was checked.
• title_added_cloudscript
  This event is triggered when new CloudScript is uploaded to PlayFab.
• title_published_cloudscript
  An inactive revision of CloudScript has been made into the active ‘live’ version.
• title_scheduled_cloudscript_executed
  This event is triggered when a CloudScript function is run by a scheduled task.
• cloudscript_executed
  This event is triggered when a CloudScript function is executed.

​

DeveloperIdentity

• studio_created
  This event is triggered when a studio is created.
• studio_user_added This event is triggered when a user accepts a studio invitation.
• studio_user_invited
  This event is triggered when a user is invited to a studio.
• studio_user_removed
  This event is triggered when a user is removed from a studio.

​

Experimentation

• exclusion_group_created This event is triggered when an exclusion group is created.
• exclusion_group_deleted This event is triggered when an exclusion group is deleted.
• exclusion_group_updated This event is triggered when an exclusion group is updated.
• experiment_created This event is triggered when an experiment is created.
• experiment_deleted This event is triggered when an experiment is deleted.
• experiment_start_requested This event is triggered when an experiment start is requested.
• experiment_stop_requested This event is triggered when an experiment stop is requested.
• experiment_updated This event is triggered when an experiment is updated.
• player_experiment_variants_changed This event is triggered when a player’s experiment variants are changed.

​

Extension

• title_aborted_task
  This event is triggered when a task instance is aborted.
• title_completed_task
  This event is triggered when a scheduled task has completed
• title_created_task
  This event is triggered when a task is created.
• title_deleted_task
  This event is triggered when a task is deleted.
• title_exceeded_limit
  This event is triggered when a title exceeds a service limit and receives an error.
• title_limit_changed
  This event is triggered when a title changes a service limit.
• title_started_task
  This event is triggered when a task is scheduled to run.
• title_updated_task
  This event is triggered when a task is updated.
• export_completed
  This event is triggered when an export operation is completed.

​

Functions

• function_executed
  This event is triggered when a function is executed.
• function_registered
  This event is triggered when a function is registered.
• function_unregistered
  This event is triggered when a function is unregistered.
• player_triggered_action_executed_function
  This event is triggered when a function is run as the result of a PlayStream action.
• title_scheduled_function_executed
  This event is triggered when a function is run by a scheduled task.

​

Groups

• group_created This event is triggered when an entity group is created.
• group_members_added
  This event is triggered when a member is added to an entity group.
• group_members_removed
  This event is triggered when a member is removed from an entity group.
• group_role_created
  This event is triggered when a role is created for a group.
• group_role_deleted
  This event is triggered when a role is deleted from a group.
• group_role_members_added
  This event is triggered when a list of entities are added to a role within a group.
• group_role_members_removed
  This event is triggered when a list of entities are removed from a role within a group.
• group_role_updated
  This event is triggered when a role is updated within a group.
• group_updated
  This event is triggered when an entity group is updated.
• members_added
  This event is triggered when members are added to a group.
• members_removed
  This event is triggered when members are removed from a group.
• members_role_updated
  This event is triggered when members’ roles are updated in a group.
• player_updated_membership
  This event is triggered when a player’s membership is updated.
• role_updated
  This event is triggered when a role is updated.

​

Telemetry

• apikey_activated
  This event is triggered when an API key is activated.
• apikey_created
  This event is triggered when an API key is created.
• apikey_deactivated
  This event is triggered when an API key is deactivated.
• apikey_deleted
  This event is triggered when an API key is deleted.

​

TitleCommunications

• player_registered_push_notifications
  This event is triggered when a player registers for push notifications.
• sent_email
  This event is triggered when an email is sent or fails to send to a player.
• sent_push_notification
  This event is triggered when a push notification is sent or fails to be sent to a player.
• email_sent
  This event is triggered when an email is sent.
• push_notification_sent
  This event is triggered when a push notification is sent.

​

General

• entity_virtual_currency_balances_changed
  This event is triggered when an entity’s virtual currency balance changes.
• tenancy_connector_onboard
  This event is triggered when a tenancy connector is onboarded.
• studio_tier_updated
  This event is triggered when a studio tier is updated.

​

Matchmaking

• title_queue_config_updated
  This event is triggered when a queue config is changed.
• match_found
  This event is triggered when a match is found.
• ticket_completed
  This event is triggered when a ticket is completed.
• user_ticket_invited
  This event is triggered when a user is invited to a ticket.

​

Multiplayer Servers

• build_alias_created
  This event is triggered when a multiplayer server build alias is created.
• build_alias_deleted
  This event is triggered when a multiplayer server build alias is deleted.
• build_alias_updated
  This event is triggered when a multiplayer server build alias is updated.
• build_deleted
  This event is triggered when a multiplayer server build is deleted.
• build_region_status_changed
  This event is triggered when a multiplayer server build region status is changed.
• build_region_updated
  This event is triggered when a multiplayer server build region is updated.
• build_region_utilization
  This event is triggered to display the utilization of servers for a build in each region.
• certificate_deleted
  This event is triggered when a multiplayer server certificate is deleted.
• certificate_uploaded
  This event is triggered when a multiplayer server certificate is uploaded.
• crash_detected
  This event triggered when a crash dump is found on a terminating server.
• create_build_initiated
  This event is triggered when a multiplayer server build is initiated.
• enabled_for_title
  This event is triggered when a title enables PlayFab servers
• game_asset_deleted
  This event is triggered when a multiplayer server game asset is deleted.
• monitoring_output_saved
  This event is triggered when the output of a monitoring application has been saved and can be downloaded.
• secret_added
  This event is triggered when a multiplayer server secret is added.
• secret_deleted
  This event is triggered when a multiplayer server secret is deleted.
• server_requested
  This event is triggered when a multiplayer server is requested.
• server_state_changed
  This event is triggered when a multiplayer server’s state is changed.
• vm_assigned
  This event is triggered when a virtual machine is assigned to a multiplayer server build.
• vm_game_certificates_deployed
  This event is triggered when game certificates are deployed in a game virtual machine.
• vm_remote_user_created
  This event is triggered when a multiplayer server virtual machine remote user is created.
• vm_remote_user_deleted
  This event is triggered when a multiplayer server virtual machine remote user is deleted.
• vm_state_change
  This event is triggered when a multiplayer virtual machine’s state is changed.
• vm_unassignment_started
  This event is triggered when a virtual machine is unassigned from a multiplayer server build.
• vm_unhealthy
  This event is triggered when a virtual machine is found to be unhealthy.

​

CatalogV1

• title_catalog_updated
  This event is triggered when a catalog is changed.
• title_store_updated
  This event is triggered when a store is changed.

​

CatalogV2

• item_created
  This event is triggered when an item is created.
• item_deleted
  This event is triggered when an item is deleted.
• item_moderation_state_changed
  This event is triggered when an item moderation state is changed.
• item_publish_requested
  This event is triggered when publishing is started.
• item_purchased
  This event is triggered when an item is purchased.
• item_reported
  This event is triggered when an item is reported.
• item_updated
  This event is triggered when an item is updated.
• review_reported
  This event is triggered when a review is reported.
• reviews_takedown_requested
  This event is triggered when a takedown of reviews is requested.

​

Character

• character_consumed_item
  This event is triggered when a character consumes an item from their inventory.
• character_inventory_item_added
  This event is triggered when an item is granted to a character.
• character_vc_item_purchased
  This event is triggered when the character makes a purchase using virtual currency.
• character_virtual_currency_balance_changed
  This event is triggered when a character’s virtual currency balance changes.

​

Inventory

• items_added
  Event raised when items have been added to an inventory.
• items_clawback_completed
  This event is triggered when an items clawback operation is completed.
• items_clawback_reversal_completed
  This event is triggered when an items clawback reversal operation is completed.
• items_deleted
  Event raised when items have been deleted from an inventory.
• items_expired
  This event is triggered when items have expired in an inventory.
• items_purchased
  Event raised when items have been purchased from an inventory.
• items_redeemed
  Event raised when items have been redeemed to an inventory.
• items_subtracted
  Event raised when items have been subtracted from an inventory.
• items_transferred
  Event raised when items have been transferred to or from an inventory.
• items_updated
  Event raised when items have been updated in an inventory.
• marketplace_transaction_redeemed
  This event is triggered when a marketplace transaction is redeemed.

​

GameSave

• gamesave_version_finalized
  This event is triggered when a game save version is finalized with all the files fully uploaded.
• gamesave_version_marked_known_good
  This event is triggered when a game save version is marked as known good.

​

Networking

• client_authentication_completed
  This event is triggered when client authentication is completed.
• client_connected_to_network
  This event is triggered when a client connects to a network.
• client_initialization_completed
  This event is triggered when client initialization is completed.
• client_network_created
  This event is triggered when a client network is created.
• client_network_destroyed
  This event is triggered when a client network is destroyed.
• client_network_information_received
  This event is triggered when client network information is received.
• client_request_failed
  This event is triggered when a client request fails.
• data_received_by_clients
  This event is triggered when data is received by clients.
• data_sent_by_clients
  This event is triggered when data is sent by clients.
• moderation_service_request_count
  This event is triggered when moderation service request count is reported.
• player_disconnected_from_network
  This event is triggered when a player disconnects from a network.
• unity_client_initialization_completed
  This event is triggered when Unity client initialization is completed.
• unreal_client_initialization_completed
  This event is triggered when Unreal client initialization is completed.

​

Partner

• display_name_filtered
  This event is triggered when a display name is filtered by community sift.
• player_display_name_filtered
  This event is triggered when a display name is filtered by community sift only if there’s an associated player EntityId for the event.
• player_photon_session_authenticated
  This event is triggered when a player connects to a Photon Cloud application and authenticates with PlayFab using Photon custom authentication.

​

Player

• player_action_executed
  This event is triggered when an action linked to a segmentation change or event rule executes on a player.
• player_ad_campaign_attribution
  This event is triggered by an attribution tracking Add-on when a player is matched to a paid acquisition campaign.
• player_consumed_item
  This event is triggered when a player consumes an item from their inventory.
• player_inventory_item_added
  This event is triggered when an item is granted to a player.
• player_paid_for_purchase
  This event is triggered when the second step of the payment process completes, paying for the purchase.
• player_realmoney_purchase
  This event is triggered when a player makes a real money purchase, and generates revenue for the game.
• player_receipt_validation
  This event is triggered when a player attempts to make a real money purchase and the purchase receipt is being validated.
• player_redeemed_coupon
  This event is triggered when a player redeems a coupon.
• player_set_profile_property
  This event is triggered when PlayFab makes an internal adjustment to a player profile.
• player_started_purchase
  This event is triggered when a player starts a purchase.
• player_vc_item_purchased
  This event is triggered when the player makes a purchase using virtual currency.
• player_virtual_currency_balance_changed
  This event is triggered when a player’s virtual currency balance changes.

​

PlayerIdentity

• auth_token_validated
  This event is triggered when an email confirmation link is clicked.
• character_created
  This event is triggered when a character is created for the first time.
• entity_created
  This event is triggered when an entity is created.
• entity_logged_in
  This event is triggered when an entity has logged in.
• player_added_title
  This event is triggered when a player creates a new account for a title. Note: this event is triggered once per title rather than once per publisher.
• player_banned
  This event is triggered when a player is banned.
• player_changed_avatar
  This event is triggered when a player’s avatar URL is changed.
• player_completed_password_reset
  This event is triggered when a player completes the password reset process by visiting the link URL that was sent to them and choosing a new password.
• player_created
  This event is triggered when a player account is created for the first time. Note: this event is only triggered once per publisher, not once per title.
• player_data_exported
  This event is triggered when a player’s data is exported.
• player_device_info
  This event is triggered once after the player logs in based on the settings for your title.
• player_displayname_changed
  This event is triggered when a player’s display name is changed.
• player_linked_account
  This event is triggered when a new authentication method is linked to a player’s account.
• player_logged_in
  This event is triggered when a player logs in.
• player_password_reset_link_sent
  This event is triggered when a player is sent a link to reset their password.
• player_removed_title
  This event is triggered when a player account for a title is removed. Note: this event is triggered once per title rather than once per publisher.
• player_reported_as_abusive
  This event is triggered when a player is reported by another player as abusive.
• player_tag_added
  This event is triggered when a tag is added to a player profile.
• player_tag_removed
  This event is triggered when a tag is removed from a player profile.
• player_unlinked_account
  This event is triggered when an authentication method is unlinked from a player’s account.
• player_updated_contact_email
  This event is triggered when a player updates a contact email on their profile.
• player_verified_contact_email
  This event is triggered when a contact email is verified for a player.
• title_deleted_master_player
  This event is triggered when a GDPR delete is finished.
• title_initiated_player_password_reset
  This event is triggered when a title initiates the account recovery process for a player.
• title_profile_view_constraints_changed
  This event is triggered when a profile view constraint is changed for the title.
• entity_deleted
  This event is triggered when an entity is deleted.
• logged_in_to_title
  This event is triggered when a user logs in to a title.
• player_authenticated
  This event is triggered when a player is authenticated.
• player_custom_properties_changed
  This event is triggered when a player’s custom properties are changed.
• player_identity_link_added
  This event is triggered when a player identity link is added.
• player_identity_link_removed
  This event is triggered when a player identity link is removed.
• player_updated_login_email
  This event is triggered when a player updates their login email.

​

PlayerProfile

• entity_files_set
  This event is triggered when files are attached to an entity.
• entity_language_updated
  This event is triggered when the language associated with an entity is changed.
• entity_objects_set
  This event is triggered when objects are attached to an entity.
• access_policy_updated
  This event is triggered when an access policy is updated.
• avatar_url_updated
  This event is triggered when an avatar URL is updated.
• contact_email_updated
  This event is triggered when a contact email is updated.
• files_changed
  This event is triggered when files are changed.
• language_updated
  This event is triggered when a language setting is updated.
• objects_updated
  This event is triggered when objects are updated.

​

PlayStream

• action_executed
  This event is emitted when an action is executed.
• action_failed
  This event is emitted when an action failed to execute.

​

Segmentation

• segment_entered
  This event is triggered when a profile enters a segment.
• segment_exited
  This event is triggered when a profile exits a segment.
• api_operation
  This event is triggered to summarize the actions taken during an invocation of the segmentation CRUD API.

​

Session

• client_focus_change
  This event is triggered every time the application enters or exits focus on the player’s device.
• client_session_start
  This event is triggered when a new client session starts.

​

Title

• title_client_rate_limited_alert
  This event is triggered when a single IP address generates too many API calls to PlayFab and is throttled.
• title_high_error_rate_alert
  This event is triggered when a game title experiences a high rate of errors.
• title_requested_limit_change
  This event is triggered when a title requests a service limit change.
• title_saved_survey
  This event is triggered when a game’s survey is saved.

​

TitleData

• title_news_updated
  This event is triggered when a title news is created or updated.
• title_secret_key_changed
  This event is triggered when a title adds or updates a Secret Key
• title_activated
  This event is triggered when a title is activated.
• title_data_override_deleted
  This event is triggered when a title data override is deleted.
• title_data_updated
  This event is triggered when title data is updated.
• title_deactivated
  This event is triggered when a title is deactivated.

​

TargetedConfiguration

• player_churn_prediction_changed
  This event is triggered when a player’s churn prediction is changed.

​

Statistics

• statistic_updated
  This event is triggered when a statistic is updated.

​

Leaderboards

• character_statistic_changed
  This event is triggered when a character statistic is changed.
• character_statistic_deleted
  This event is triggered when a character statistic is deleted.
• entity_rank_on_leaderboard_version_ended
  This event is triggered when a leaderboard version is reset
• leaderboard_version_ended
  This event is triggered when a leaderboard version is reset
• player_ranked_on_leaderboard_version
  This event is triggered when a leaderboard version changes, generating events for top‑ranked players up to the limit defined by the “Leaderboard version change top rank events sent” setting.
• player_statistic_changed
  This event is triggered when a player statistic is changed.
• player_statistic_deleted
  This event is triggered when a player statistic is deleted.
• title_statistic_version_changed
  This event is triggered when the version of a statistic changes, causing its leaderboard to reset.
• title_statistic_deleted
  This event is triggered when a title statistic is deleted.