Lucra-Owned Tournaments Backend Integration

This requires the Server to Server API Integration, you can check how to implement it here.

Update Users Scores

Update the scores of the users inside a tournament. Can be called with the full list of users or with only the users that need to be updated. Scores can be updated more than once per user during the lifespan of the tournament If the attemptFinished property is passed as true, then the user round will be marked as finished and it will no longer accept new updates (it will fail the request). This is also a requirement to the Replay functionality to allow players to join a tournament more than once, it enables the Join action once again. If it's passed as false it will just update the first available/open score attempt and it will not prevent further updates If, no round complete logic can be implemented, a way to disable this attempt complete check is to pass the omitAttemptCompletedCheck when creating the tournament, thus ignoring the closure of the attempt when a Player tries to join again (this is useful when the scoring attempt logic is fully controlled on the tenant side)

See user.canSubmitNewScore to determine if a user can have a new score submited

PUT | PATCH /api/rest/pool-tournament/${matchupId}/users-scores

{
  "apiKey": "your-Lucra-assigned-api-key", // contact account manager for details
  "object" {
    "userScores": [
      {
        "userId": "user-uuid-string"
        "score": 100, // integer with the score of the user (can be negative)
        "metadataString": "{}",  // JSON string with optional custom metadata
        "attemptFinished": true, // Marks the end of this user round (optional)
      }
    ]
  }
}

Retrieve Existing Tournament Info

Returns the data related a specific tournament ID.

GET /api/rest/pool-tournament/:matchupId?apiKey=your-Lucra-assigned-api-key

{
  "matchup": {
    "id": "64c744cf-c837-422b-9da7-ff3a359525df", // ID of the matchup record
    "type": "CASH_PERCENTAGE",
    "status": "CLOSED",
    "tenantId": "SAMPLE",
    "createdAt": "2025-01-17T20:28:20.339716+00:00",
    "expiresAt": "2025-01-31T20:00:00.000000+00:00",
    "startsAt": "2025-01-20T20:00:00.000000+00:00",
    "isPublic": true,
    "gameId": "AIR-HOCKEY",
    "title": "Awesome Tournament",
    "description": "The most Awesome Tournament",
    "metadataString": "{ \"someProperty\": 123 }",
    "locationIds": [
      "2f2d279b-6149-40a7-9f6d-38d9cbea23cd", 
      "ef01589e-c9ac-4214-846a-39648eccfbb9"
    ],
    "fee": 5,
    "buyInAmount": 10,
    "numberOfParticipants": 3,
    "maxParticipants": 250,
    "maxAttempts": 3,
    "poolNetAmount": 28.5,
    "scoringType": "HIGHEST_SCORE", // or LOWEST_SCORE,
    "privateCode": "PV6485",
    "rewardStructure": [
      {
        "position": 1,
        "positionOverride": null,
        "value": 100,
        "userId": "33e35526-410c-4517-81c3-2162cde5c786",
        "userName": "DivineTarantula",
        "tierNetAmount": 28.5
      }
    ],
    "users": [
      {
        "userId": "33e35526-410c-4517-81c3-2162cde5c786",
        "userName": "DivineTarantula",
        "userAvatarUrl": "https://api.lucrasports.com/assets/some-path-to-img",
        "position": 1,
        "positionOverride": null,
        "metadataString": "{}",
        "score": 580,
        "rewardNetAmount": 28.5,
        "canSubmitNewScore": false
      },
      {
        "userId": "13c7a90f-76c8-401e-afee-f7d81d8e4420",
        "userName": "FunnyBoar",
        "userAvatarUrl": "https://api.lucrasports.com/assets/some-path-to-img",
        "position": 2,
        "positionOverride": null,
        "metadataString": "{}",
        "score": 570,
        "rewardNetAmount": 0,
        "canSubmitNewScore": false,
      },
      {
        "userId": "a0116f41-cbd3-4d84-b445-8228baf3d908",
        "userName": "SpareWasp",
        "userAvatarUrl": "https://api.lucrasports.com/assets/some-path-to-img",
        "position": 3,
        "positionOverride": null,
        "metadataString": "{}",
        "score": 550,
        "rewardNetAmount": 0,
        "canSubmitNewScore": true
      }
    ]
  }
}

{
    "matchup": {
        "id": "eb77921c-aad1-4ac3-b64b-916c45c1373d", // ID of the matchup record
        "status": "CONFIRMED",
        "createdAt": "2024-12-24T23:04:56.668214+00:00",
        "totalPoolAmount": 20, // total amount of the pool
        "users": [
            {
                "user_id": "user-uuid-string"
            }
        ]
    }
}