Events fire at 10:00 UTC the day before the leaderboard’s UTC start time. This
is because leaderboard runs are relative to each user’s time zone, and the
start event must fire before users in the most advanced time zones begin
ranking. Make sure to take into account users’ time zones if scheduling
notifications from this webhook event .
Available options:
leaderboard.started
leaderboard
LeaderboardResponseWithRankings · object
required
The leaderboard run that started and its initial rankings.
A leaderboard with its configuration details.
The unique ID of the leaderboard.
Example: "5100fe51-6bce-6j44-b0hs-bddc4e123682"
The user-facing name of the leaderboard.
Example: "Weekly Word Count Challenge"
The unique key used to reference the leaderboard in APIs.
What the leaderboard ranks by.
Available options:
points,
streak,
metric
leaderboard. breakdownAttribute
The key of the attribute to break down this leaderboard by.
The user-facing description of the leaderboard.
Example: "Compete weekly to see who writes the most words"
The start date of the leaderboard in YYYY-MM-DD format.
leaderboard. end
string<date> | null
required
The end date of the leaderboard in YYYY-MM-DD format, or null if it runs forever.
leaderboard. maxParticipants
The maximum number of participants in the leaderboard.
leaderboard. runUnit
enum<string> | null
required
The repetition type for recurring leaderboards, or null for one-time leaderboards.
Available options:
day,
month,
year,
The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.
The status of the leaderboard.
Available options:
active,
scheduled,
finished
leaderboard. rankings
LeaderboardRanking · object[]
required
Array of user rankings for the leaderboard.
leaderboard.rankings. userId
leaderboard.rankings. userName
The name of the user. May be null if no name is set.
leaderboard.rankings. rank
The user's rank in the leaderboard.
leaderboard.rankings. value
The user's value for this leaderboard (points, metric value, etc.).
The key of the metric to rank by, if rankBy is 'metric'.
The name of the metric to rank by, if rankBy is 'metric'.
leaderboard. pointsSystemKey
The key of the points system to rank by, if rankBy is 'points'.
leaderboard. pointsSystemName
The name of the points system to rank by, if rankBy is 'points'.
Return a 200 status to indicate the webhook was received and processed.
