Overview
The following describes the key events in a cricket game as told by PlayHQ’s live game webhook solution and aims to assist integration partners to integrate with these webhooks.
This solution is only applicable to cricket currently. As this expands to become available for other sports, more sample data will added here.
See the Live Scoreboard Integration article for more information.
Terms of use
PlayHQ webhook subscription
Sample data
Webhooks utilised for key events in a game’s lifecycle
The table below illustrates which webhook should be consumed for each high-level key event in a game of Cricket. Please see the following page for a more comprehensive look at the webhooks used to describe game events:
| User Action | Webhook | Additional Notes |
| Line-ups selected | Live game detail |
When players have been selected in a line-up prior to the game starting, the live game detail webhook will fire when “Done” is selected on the lineups page for either team. |
| Coin toss outcome recorded | Live game detail | When the coin toss winner has been chosen, along with preference, the live game detail webhook will fire. |
| Start of innings | Live game scorecard | When innings are started, the live game scorecard webhook will fire. |
| Line-up adjustments are made | Live game detail | When players have been updated in a line-up after the game has begun (via the Options>Inning Settings>Edit Lineups menu), the live game detail webhook will fire when “Done” is selected on the lineups page for either team. |
| Ball-based events are recorded | Live game score event | As each event is recorded, the live game score event webhook will fire containing details of what happened and whom was involved. |
|
Any event is undone. Note that the undo event is directly related to the “undo” button in the electronic scoring application, specifically, and not the “edit event log” action. |
Live game event undo | When an event is undone, the live game event undo webhook will fire containing the event ID and other details of what was undone. |
|
Any event is undone. Note that the undo event is directly related to the “undo” button in the electronic scoring application, specifically, and not the “edit event log” action. |
Live game scorecard | When an event is undone, the live game scorecard webhook will also fire (along with the live game event undo webhook) containing the current scorecard after the corresponding event was undone. |
| Player change during game e.g.: -bowler change -strike batter switch -change of batter |
Live game scorecard | When players change during the game, the live game scorecard webhook will fire and will reflect the change. |
| Scorecard is adjusted at end of over | Live game scorecard | When the scorecard is adjusted at the end of an over, the live game scorecard webhook will fire, providing the scorecard updates. |
| New over begins | Live game scorecard | When a new over is started, the live game scorecard webhook will fire, providing the scorecard details as at the start of the new over. |
| Player is retired - out or not out | Live game scorecard | When a player is retired, the live game scorecard webhook will fire, providing the scorecard updates. |
| Penalty runs are applied | Live game scorecard | When penalty runs are applied, the live game scorecard webhook will fire, providing the scorecard updates. |
| Adjust parameters event | Live game score event | When the game’s parameters are adjusted the live game webhook will fire, providing details of the adjustment. |
| Start/end break | Live game score event | When a break is started/ended the live game webhook will fire, providing details of the break. |
| End of innings | Live game scorecard | When end of innings is confirmed, the live game scorecard webhook will fire, providing the scorecard updates. |
| Game is reset | Live game reset | When game is reset, the live game reset webhook will fire, indicating that the game has been reset. |
| End of game | Game updated | When game is finalised, the game updated webhook will fire, providing the finalised status outcome and game details. |
| Game is forfeited or abandoned | Live game detail | When game is forfeited or abandoned, the live game detail webhook will fire, providing this status. |
Live game webhooks - Sample payloads
Download the attachments below to see sample payloads of this cricket data.