Skip to content

Payloads

Every entity event has the same five top-level keys.

{
"type": "update",
"entity": "fact",
"competitionId": 2311,
"date": "2026-09-12T10:04:31.118Z",
"data": {}
}
KeyTypeMeaning
typecreate | update | deleteThe verb
entitymatch | team | fact | competition | summary | overlayThe entity
competitionIdnumberThe competition the change belongs to
dateISO 8601 stringWhen LIGR queued the event
dataobjectThe entity, in the webhook shape

Use (entity, data.id, date) as your deduplication key. Delivery is at least once: the same event can arrive twice with the same key.

Send test event on the webhook page sends one signed test request. Its type is Test, its entity is test, it adds test: true, and it has no competitionId. Drop it after you verify the signature.

data.homeTeam and data.awayTeam follow competitorsType. A teams match carries a team object. A singles match carries a player. A doubles match carries a pair.

lineups is present when a teams match has a lineup.

{
"type": "update",
"entity": "match",
"competitionId": 2311,
"date": "2026-09-12T10:04:31.118Z",
"data": {
"id": 1188213,
"competitorsType": "teams",
"homeTeam": { "id": 5021, "name": "Sydney FC" },
"awayTeam": { "id": 5030, "name": "Melbourne City" },
"competition": { "id": 2311, "name": "League" },
"venue": { "id": 412, "name": "Main Stadium" },
"overlays": [{ "id": 2300003, "key": "3f2a9c1e-4b6d-4e8f-9a0b-1c2d3e4f5a6b" }],
"score": { "home": 1, "away": 0 },
"clockData": { "clockRunning": true, "clockInMs": 1712000, "clockChangeDate": "2026-09-12T09:35:59.118Z" },
"liveStatus": "live",
"finishedStatus": "inProgress",
"currentPeriod": { "number": 1, "name": "1st half", "status": "live" },
"date": "2026-09-12T09:30:00.000Z",
"coverage": true,
"createdAt": "2026-09-01T02:14:09.000Z",
"updatedAt": "2026-09-12T10:04:31.118Z",
"deletedAt": null,
"lineups": {
"home": { "teamId": 5021, "teamGfxName": "SYD", "starters": [], "bench": [] },
"away": { "teamId": 5030, "teamGfxName": "MCY", "starters": [], "bench": [] }
}
}
}

A fact carries its match, its type, its clock position and the competitors it names. An undone fact arrives as a delete.

A summary event carries the computed score, the periods and the statistics of one match. LIGR sends it after it folds a fact change into the summary. A summary delete carries ids only.

An overlay event carries the overlay record: the key a browser source uses, the match it belongs to, and the switches an operator or the REST API changes. A new key arrives as an update.

{
"type": "update",
"entity": "overlay",
"competitionId": 2311,
"date": "2026-09-12T10:04:31.118Z",
"data": {
"id": 2300003,
"key": "3f2a9c1e-4b6d-4e8f-9a0b-1c2d3e4f5a6b",
"name": "Broadcast",
"matchId": 1188213,
"competitionThemeSettingId": 8802,
"controlRoomId": 91,
"controllerId": null,
"isPrimary": true,
"isActive": true,
"autoMode": false,
"encodingDelay": 6,
"adType": "free",
"lng": null,
"createdAt": "2026-09-01T02:14:09.000Z",
"updatedAt": "2026-09-12T10:04:31.118Z",
"deletedAt": null
}
}

A team event carries the team as the competition holds it, including gfxName. A competition event carries the competition record.

The webhook payload of an entity tracks the entity itself. To see every field your competition produces, log the raw body of one live delivery on your endpoint. The Event Logs tab in the dashboard shows the entity, the type, the attempts and the status of each delivery. View on a row shows the exact request body of that attempt, up to 16 KiB. See Delivery health & logs.