Achievements
Streaks
Points
Leaderboard changed
Triggered when leaderboard rankings change.
Body
The webhook event.
The webhook event type.
leaderboard.changed The leaderboard run that changed. A leaderboard with its configuration details.
Show child attributes
Show child attributes
The unique ID of the leaderboard.
"5100fe51-6bce-6j44-b0hs-bddc4e123682"
The user-facing name of the leaderboard.
"Weekly Word Count Challenge"
The unique key used to reference the leaderboard in APIs.
"weekly-words"
What the leaderboard ranks by.
points, streak, metric "metric"
The key of the attribute to break down this leaderboard by.
"country"
The user-facing description of the leaderboard.
"Compete weekly to see who writes the most words"
The start date of the leaderboard in YYYY-MM-DD format.
"2025-01-01"
The end date of the leaderboard in YYYY-MM-DD format, or null if it runs forever.
"2025-12-31"
The maximum number of participants in the leaderboard.
100
The repetition type for recurring leaderboards, or null for one-time leaderboards.
day, month, year, "day"
The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.
7
The status of the leaderboard.
active, scheduled, finished "active"
Array of user rankings for the leaderboard.
Show child attributes
Show child attributes
The ID of the user.
"user-123"
The name of the user. May be null if no name is set.
"Alice Johnson"
The user's rank in the leaderboard.
1
The user's value for this leaderboard (points, metric value, etc.).
5000
The key of the metric to rank by, if rankBy is 'metric'.
"words-written"
The name of the metric to rank by, if rankBy is 'metric'.
"Words Written"
The key of the points system to rank by, if rankBy is 'points'.
"xp-system"
The name of the points system to rank by, if rankBy is 'points'.
"Experience Points"
Response
Return a 200 status to indicate the webhook was received and processed.
Was this page helpful?