Saltar al contenido principal
WEBHOOK
leaderboard.finished
{
  "type": "leaderboard.finished",
  "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
      }
    ]
  }
}
Los eventos se activan entre las 13:00 y las 13:59 UTC del día siguiente al final de una ejecución de clasificación. Esto se debe a que cada ejecución de clasificación es relativa a la zona horaria de cada usuario, y los usuarios en las zonas horarias más retrasadas deben tener la oportunidad de finalizar.
Los eventos solo incluyen las 10 clasificaciones principales de usuarios. Para obtener más, utiliza la API de clasificación individual.

Cuerpo

application/json

The webhook event.

type
enum<string>
requerido

The webhook event type.

Opciones disponibles:
leaderboard.finished
leaderboard
LeaderboardResponseWithRankings · object
requerido

The leaderboard run that finished and its final rankings.

Respuesta

200

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