Skip to main content
WEBHOOK
leaderboard.started
{
  "type": "leaderboard.started",
  "leaderboard": {
    "id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
    "name": "Weekly Word Count Challenge",
    "key": "weekly-words",
    "rankBy": "metric",
    "metricKey": "words-written",
    "metricName": "Words Written",
    "pointsSystemKey": null,
    "pointsSystemName": null,
    "description": "Compete weekly to see who writes the most words",
    "status": "active",
    "start": "2025-01-01",
    "end": null,
    "maxParticipants": 100,
    "runUnit": "day",
    "runInterval": 7,
    "rankings": [
      {
        "userId": "user-123",
        "userName": "Alice Johnson",
        "rank": 1,
        "value": 1
      }
    ]
  }
}
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.

Body

application/json

The webhook event.

type
enum<string>
required

The webhook event type.

Available options:
leaderboard.started
leaderboard
object
required

The leaderboard run that started and its initial rankings. A leaderboard with its configuration details.

Response

200

Return a 200 status to indicate the webhook was received and processed.

I