Skip to main content
With Leaderboards integration to PlayStream, you can easily leverage the real-time event ingestion and processing pipeline to build custom player experiences that are triggered when a Leaderboard version changes. With PlayStream Actions and Rules, you can trigger custom CloudScripts or Azure Functions to drive engagement and retention features like granting rewards to top players, sending personalized notifications to players, or performing score validation to check for cheaters. PlayStream Events will also be archived in Data Explorer for data analytics and warehousing. And if you want just the data analytics and warehousing without the real-time event actions, Leaderboards has an integration with Telemetry Events to provide just the analytics features. Leaderboards provides two optional events: These two events allow you to quickly know when a leaderboard version has ended and allow you to query previous data as soon as you want. With entity rank on leaderboard version ended, you can get the rank and score of the top entity for a leaderboard when that leaderboard version ended.

​
Enable PlayStream or Telemetry Events

You can enable events when creating a new leaderboard or editing and existing leaderboard definition. Find the section for PlayStream and telemetry event configuration and select None, PlayStream, or Telemetry.
Note: Preexisting leaderboards will have both leaderboard version ended and entity rank on leaderboard version ended events turned off by default. If you want to enable them or just one of them, please go to the leaderboard you want to modify and enable that setting.
Once submitted, events be emitted whenever a leaderboard version changes.

​
Event Usage

For learning more about how to leverage these events to perform different actions such as connecting to an Azure Function, please check out these resources:

​
Restrictions & Notes

  • The playfab.leaderboard.entity_rank_on_leaderboard_version_ended event, will only return up to the top 1000 ranks.
  • The playfab.leaderboard.entity_rank_on_leaderboard_version_ended event, will send an event for every entry within the leaderboard.
  • The playfab.leaderboard.entity_rank_on_leaderboard_version_ended event, will not work with leaderboards with a entity type of master_player_account or external.

​
See Also

Last modified on August 4, 2026

Related topics

Statistics with PlayStream and TelemetryPlayFab Leaderboards overviewGame Saves PlayStream eventsPlayStream event model reference for PlayFabInsights Best Practices