Documentation

PlayFab Playstreameventmodels API Categories

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 WriteEvent APIs.

Each event type has a set of properties that are included as part of event's data wherever it is sent. You can view these properties and build rules for triggering actions based on their values in the PlayStream tab of the Game Manager.

General - (46)

Character - (7)

Partner - (3)

  • 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 is 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 - (49)

  • auth_token_validated

    This event is triggered when an email confirmation link is clicked.

  • title_deleted_master_player

    This event is triggered when a GDPR delete is finished.

  • 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_ad_closed

    This event is triggered when a player closes an ad.

  • 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_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 recieves an ad reward.

  • player_ad_activity_valued

    Event triggered when reported value of ad view is recorded

  • player_ad_started

    This event is triggered when a player starts an ad.

  • 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_consumed_item

    This event is triggered when a player consumes an item from their inventory.

  • 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_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_inventory_item_added

    This event is triggered when an item is granted to a player.

  • player_joined_lobby

    This event is triggered when a player joins a multiplayer game session.

  • player_left_lobby

    This event is triggered when a player leaves a multiplayer game session.

  • 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_matched_with_lobby

    This event is triggered when a player is assigned to a game lobby and issued a connection ticket, before the player has connected to the game lobby.

  • player_password_reset_link_sent

    This event is triggered when a player is sent a link to reset their password.

  • player_paid_for_purchase

    This event is triggered when the second step of the payment process completes, paying for the purchase.

  • player_ranked_on_leaderboard_version

    This event is triggered for the top-ranked players on a leaderboard when the leaderboard version changes (e.g. when a leaderboard statistic version is incremented). The maximum number of leaderboard entries for which the event is generated is controlled by the "Leaderboard version change top rank events sent" title limit.

  • 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_registered_push_notifications

    This event is triggered when a player registers for push notifications.

  • 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_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_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.

  • 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_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.

  • 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_vc_item_purchased

    This event is triggered when the player makes a purchase using virtual currency.

  • player_verified_contact_email

    This event is triggered when a contact email is verified for a player.

  • player_virtual_currency_balance_changed

    This event is triggered when a player's virtual currency balance changes.

  • sent_push_notification

    This event is triggered when a push notification is sent or fails to be sent to a player.

  • sent_email

    This event is triggered when an email is sent or fails to send to a player.

Session - (8)

Title - (27)