Scheduled Game Objects - Gamification
Scheduled Game Objects
Automate status transitions for game objects (e.g., enable a leaderboard at event start, disable at event end).
Parameters (create)
| Parameter | Type | Required | Description |
|---|---|---|---|
gameObjectType | string | Yes | Type of game object: "leaderboard", "certificate", "badge", "leadScoring" |
gameObjectId | string | Yes | ID of the game object to schedule |
scheduledAction | string | Yes | Action to perform: "enable" or "disable" |
scheduledDate | string | Yes | When to execute the action, in ISO 8601 format |
# Schedule leaderboard to enable at event start
curl -X POST "$KALTURA_SCM_URL/scheduledGameObject/create" \
-H "Authorization: Bearer $KALTURA_KS" \
-H "Content-Type: application/json" \
-d '{
"gameObjectType": "leaderboard",
"gameObjectId": "'$LEADERBOARD_ID'",
"scheduledAction": "enable",
"scheduledDate": "2025-06-01T09:00:00Z"
}'
# Schedule leaderboard to disable at event end
curl -X POST "$KALTURA_SCM_URL/scheduledGameObject/create" \
-H "Authorization: Bearer $KALTURA_KS" \
-H "Content-Type: application/json" \
-d '{
"gameObjectType": "leaderboard",
"gameObjectId": "'$LEADERBOARD_ID'",
"scheduledAction": "disable",
"scheduledDate": "2025-06-03T18:00:00Z"
}'
# List scheduled transitions
curl -X POST "$KALTURA_SCM_URL/scheduledGameObject/list" \
-H "Authorization: Bearer $KALTURA_KS" \
-H "Content-Type: application/json" \
-d '{"pager": {"pageSize": 10, "pageIndex": 1}}'
# Delete scheduled transition
curl -X POST "$KALTURA_SCM_URL/scheduledGameObject/delete" \
-H "Authorization: Bearer $KALTURA_KS" \
-H "Content-Type: application/json" \
-d '{"id": "'$SCHEDULED_ID'"}'