Skip to main content
WEBHOOK
leaderboard.rank_changed
{
  "type": "leaderboard.rank_changed",
  "user": {
    "id": "user-id",
    "email": "user@example.com",
    "tz": "Europe/London",
    "subscribedToEmails": true,
    "created": "2021-01-01T00:00:00Z",
    "updated": "2021-01-01T00:00:00Z",
    "attributes": {
      "department": "engineering",
      "role": "developer"
    }
  },
  "leaderboard": {
    "id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
    "name": "Weekly Word Count Challenge",
    "key": "weekly-words",
    "rankBy": "metric",
    "metricKey": "words-written",
    "metricName": "Words Written",
    "description": "Compete weekly to see who writes the most words",
    "start": "2025-01-01",
    "end": null,
    "maxParticipants": 100,
    "runUnit": "day",
    "runInterval": 7,
    "rank": 2,
    "value": 4500,
    "previousRank": 1,
    "previousValue": 4500
  }
}

Body

application/json

The webhook event.

​
type
enum<string>
required

The webhook event type.

Available options:
leaderboard.rank_changed
​
user
object
required

The user whose rank changed. An object with editable user fields.

​
leaderboard
object
required

The user's leaderboard data that changed. A user's data for a specific leaderboard including rank, value, and history. A leaderboard with its configuration details.

Response

200

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

⌘I