Skip to main content
WEBHOOK
leaderboard.changed
{
  "type": "leaderboard.changed",
  "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,
    "breakdownAttribute": null,
    "runUnit": "day",
    "runInterval": 7,
    "rankings": [
      {
        "userId": "user-123",
        "userName": "Alice Johnson",
        "rank": 1,
        "value": 10
      },
      {
        "userId": "user-456",
        "userName": "Bob Smith",
        "rank": 2,
        "value": 6
      },
      {
        "userId": "user-789",
        "userName": "Charlie Brown",
        "rank": 3,
        "value": 4
      }
    ]
  }
}

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

Available options:
leaderboard.changed
​
leaderboard
object
required

The leaderboard run that changed. A leaderboard with its configuration details.

Response

200

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