A hockey rink scoreboard shows the score, the period, the clock and the penalty timers. If Scoreboard OCR or another program reads them, it can send them to ScoreCastr with the field names on this page. Field hockey uses many of the same names; its list is at the end.
Before you start
- The Pro plan. The ScoreCastr button on the ice hockey (or field hockey) Scoring tab opens the Data Hub.
- A webhook turned on for the match: on the Scoreboard OCR tab, pick HTTP Client (Webhooks), click Enable ScoreCastr and copy the Webhook URL. See Send live data by webhook.
- Scoreboard OCR users: see Connect Scoreboard OCR. Request format and replies: Webhook API reference.
Away means the away team from match setup; home is the home team. Field names are case sensitive. Fields you leave out keep their values.
Score, period and clock
| Field names | What it changes | Format |
|---|---|---|
away_score, awayScore, away_goals, awayGoals |
Away goals | Number, the game total |
home_score, homeScore, home_goals, homeGoals |
Home goals | Number, the game total |
period, currentPeriod, current_period |
Period | 1, 2, 3; 4 = OT; 5 = SO |
clock, time, timeRemaining, time_remaining, game_clock, periodTimeLeft |
Period clock | MM:SS, like 11:37, or seconds |
overtime, isOvertime, is_overtime, ot |
Overtime on or off | true, 1 or yes |
shootout, isShootout, is_shootout, so |
Shootout on or off | true, 1 or yes |
final, isFinal, is_final, gameOver |
Game final | true, 1 or yes |
Goals: send the game total. ScoreCastr puts the change into the current period, so the period-by-period scoreboard stays right. Send the period before or with the goal that changes it.
Clock: each clock value stops the dashboard's running clock and shows the value as sent. The feed has to send the clock on every update for it to count down on screen.
Shots, power plays and penalties
Replace away with home for the home team.
| Field names (away) | What it changes |
|---|---|
away_shots_on_goal, awayShotsOnGoal, awaySOG |
Shots on goal |
away_shots, awayShots |
Total shots |
away_power_play_goals, awayPowerPlayGoals, awayPPG, away_ppg |
Power play goals |
away_power_play_opportunities, awayPowerPlayOpportunities, awayPPO, away_ppo, awayPP, away_pp |
Power play chances |
away_penalty_minutes, awayPenaltyMinutes, awayPIM, away_pim |
Penalty minutes |
away_penalty_time_remaining |
Time left on the away penalty, in seconds (120 for a minor) |
away_on_power_play |
Away team on the power play: true or false |
away_saves |
Saves |
away_faceoffs_won, away_faceoffs_total |
Faceoffs |
away_hits_hockey |
Hits (note the _hockey ending) |
away_assists_hockey |
Assists (note the _hockey ending) |
away_blocked_shots, away_giveaways, away_takeaways |
Blocked shots, giveaways, takeaways |
When a team's penalty time goes from 0 to a number, ScoreCastr starts a penalty for that team and puts the other team on the power play. When it goes back to 0, the penalty and the power play end.
Example body
{
"away_score": 2,
"home_score": 1,
"period": 2,
"clock": "11:37",
"away_shots_on_goal": 18,
"home_shots_on_goal": 14,
"home_penalty_time_remaining": 94,
"away_penalty_minutes": 4,
"home_penalty_minutes": 6
}
What the scorebug does on its own
- A team's goals go up by 1: the goal animation plays for that team.
- Penalty time starts or ends: the penalty and power play show or clear, as above.
- Faceoffs won or hits go up: that stat's popup shows for a few seconds.
Field hockey
Field hockey matches take a webhook the same way. The names it reads:
| Field names | What it changes |
|---|---|
away_score, awayScore, away_goals, awayGoals (and home) |
Goals, as the game total |
quarter, currentQuarter, current_quarter, fh_quarter, field_hockey_quarter, period |
Quarter: 1 to 4, 5 = OT, 6 = SO |
clock, time, timeRemaining, time_remaining, game_clock, periodTimeLeft |
Clock, MM:SS or seconds; stops the dashboard clock like ice hockey |
overtime, shootout, final (and the is forms) |
Overtime, shootout, final |
away_green_cards, away_yellow_cards, away_red_cards |
Cards |
away_shots, away_shots_on_goal, away_saves |
Shots, shots on goal, saves |
away_fh_fouls, away_penalty_corners, away_penalty_strokes |
Fouls, penalty corners, penalty strokes |
away_penalty_corner_goals, away_penalty_stroke_goals, away_fh_assists |
Corner goals, stroke goals, assists |
Replace away with home for the home team. Camel case forms like awayShots work for the cards, shots, saves, fouls, corners and strokes. A goal going up by one plays the goal flash, and new cards play the card animation.
Fix common problems
The clock is frozen. The feed has to send the clock on every update. A clock value stops the dashboard clock.
A goal shows in the wrong period. Send the new period before or with the first goal of that period.
No power play shows. Send the penalized team's penalty time in seconds, starting from 0.
Checklist
- Pro plan, webhook enabled with HTTP Client (Webhooks)
- Goals sent as game totals
- Period sent as a number, 4 for OT and 5 for SO
- Clock sent on every update
- Penalty time in seconds
- Hockey hits and assists with the _hockey ending