event

For: READ, PUBLISH

The event message type is the most common type. It is generated when some kind of event occurs. Whether this is a shot at goal, a referee being assiged or event just the ball moving, these can all generate messages of the 'event' type.

The event messages are broken down by a number of different classifier fields. In increasing levels of granularity they are:

class

This defines the type of events this message is related to. Some examples include: sport; events relating to something that happens as part of the sporting event. EG. A shot at goal or a foul setup; events relating to the setup of the match. EG. Assiging a player to a team/position, assigning a referee

eventType

The type of the event (inside the class). For a sport class message this may be the type of shot being made, or for a setup class message the type of thing being assigned.

subType

Some eventTypes (but not all) also support a 'subType' to further classify the eventType

options

Some eventTypes/subTypes support additional options for more information about the event. These are key/pair values. While some values may be boolean (true/false) others can be integer, strings etc.

While all messages of type 'event' require a class, the other fields may or may not be required depending on the type of event.

        {
            "type": "event",
            "fixtureId": "b25692de-ac17-11e8-98d0-529269fb1459",
            "clientType": "AppName:Version",
            "data": {
                "eventId": "c2404cc0-9f75-11e8-98d0-529269fb1459",
                "entityId": "c24048a6-9f75-11e8-98d0-529269fb1459",
                "personId": "c2405b2a-9f75-11e8-98d0-529269fb1459",
                "class": "sport",
                "eventType": "2pt",
                "eventTime": "2018-08-14T16:45:33.88",
                "subType": "jumpShot",
                "options": {
                    "fastBreak": true,
                    "pointsInThePaint": true,
                    "distance": 2.3,
                },
                "clock": "PT08M23S",
                "shotClock": "PT12.3S",
                "periodId": 2,
                "success": true,
                "x": 56,
                "y": 23,
                "officialId": "c2404ff4-9f75-11e8-98d0-529269fb1459",
                "playId": "d8934b2a-9f75-11e8-98d0-529269fb1459",
                "scores": {
                    "c24048a6-9f75-11e8-98d0-529269fb1459": "56",
                    "b25692de-ac17-11e8-98d0-529269fb1459": "23",
                },
                "status": "updated",
                "timestamp": "2018-08-14T16:45:34.34"
            }
        }

For each sport/event/eventType/SubType the required fields and available different combinations are varied. Please see the list below for more information.

class

eventType

subType

options

Required Fields

setup

fixture

post

periodLengthinteger numberOfPeriodsinteger attendanceinteger Total attendance count

class eventType options.numberOfPeriods options.periodLength

person

namestring The person's name positionstring The position this person plays Allowed Values:

starterboolean Is this person a starter? captainboolean Is this person the captain? bibstring The number/position on this person's shirt/bib

class eventType personId entityId options.name

role

entity

namestring numberinteger[1-10] The persons's number, eg 2nd assistant coach bibstring The number/position on this person's shirt/bib positionstring The position/role of this person Allowed Values:

COACH
COACH_ASSISTANT

class eventType entityId

fixture

namestring numberinteger[1-10] The persons's number, eg 2nd assistant coach bibstring The number/position on this person's shirt/bib positionstring The official's position Allowed Values:

REFEREE

class eventType personId options.name options.position

sport

assist

assistPrimary

class eventType entityId periodId eventType personId

assistSecondary

class eventType entityId periodId eventType personId

block

class eventType personId entityId periodId

faceOff

lost

class eventType

won

startOfPeriodboolean At the start of the period?

class eventType entityId periodId eventType subType

fixture

abandoned

class eventType

cancelled

class eventType

confirmed

class eventType periodId

delayed

class eventType

end

class eventType periodId

pending

class eventType periodId

start

class eventType periodId

warm_up

class eventType

goal

backhand

fromPenaltyShotboolean failureReasonstring Allowed Values:

BLOCK
MISS
SAVE

emptyNetGoalboolean

class eventType

shovel

fromPenaltyShotboolean failureReasonstring Allowed Values:

BLOCK
MISS
SAVE

emptyNetGoalboolean

class eventType

slapShot

fromPenaltyShotboolean failureReasonstring Allowed Values:

BLOCK
MISS
SAVE

emptyNetGoalboolean

class eventType

snap

fromPenaltyShotboolean failureReasonstring Allowed Values:

BLOCK
MISS
SAVE

emptyNetGoalboolean

class eventType

wrist

fromPenaltyShotboolean failureReasonstring Allowed Values:

BLOCK
MISS
SAVE

emptyNetGoalboolean

class eventType

icing

class eventType periodId entityId

offside

class eventType

penalty

drawn

boardingboolean buttEndingboolean chargingboolean checkingBehindboolean checkingCrossboolean delayOfGameboolean elbowingboolean fightboolean fightInstigatorboolean headContactboolean highStickboolean hookingboolean holdingboolean holdingStickboolean holdingFacemaskboolean kneeingboolean leavingBenchboolean obstructionboolean pushingOffWithSkateboolean roughingboolean slashingboolean spearingboolean trippingboolean interferenceboolean unsportsmanlikeboolean

class eventType entityId periodId eventType personId

major

class eventType entityId periodId eventType personId

minor

class eventType entityId periodId eventType personId

misconduct

class eventType entityId periodId eventType personId

penaltyShotAwarded

class eventType entityId periodId eventType personId

period

confirmed

class eventType subType periodId

end

class eventType

pending

class eventType

start

class eventType

possession

class eventType entityId periodId

save

blockSave

class eventType entityId periodId eventType

gloveSave

class eventType entityId periodId eventType

padSave

class eventType entityId periodId eventType

stickSave

class eventType entityId periodId eventType

shootOut

class eventType periodId eventType

shootOutAttempt

made

class eventType success class eventType subType entityId periodId personId

missed

class eventType

save

howSavedstring Allowed Values:

blockSave
gloveSave
padSave
stickSave

class eventType

shootOutToss

lost

shootOutOrderinteger

class eventType

won

shootOutOrderinteger

class eventType periodId eventType

substitution

in

goalieboolean positionstring

class eventType

out

goalieboolean positionstring

class eventType

timeOut

class eventType entityId periodId eventType

toss

lost

directionstring Allowed Values:

HOME
AWAY

startPossessionboolean

class eventType

won

directionstring Allowed Values:

HOME
AWAY

startPossessionboolean

class eventType

videoReview

pending

class eventType

rejected

class eventType

upheld

class eventType

clock

main

adjust

valuestring The new value of the clock

class eventType options.value

start

class eventType subType

stop

class eventType subType

heartbeat

client

class eventType

disconnect

client

class eventType

reset

client

class eventType

clientSessionStart

client

sessionIdstring Id for the client application user session authMethodstring The authentication method used by the client application usernamestring Username of the user in the client application userIdstring User identifier in the client application

class eventType

Bold fields are required. Other fields may be required depending on the eventClass/type etc.

Field

Description

eventId

A unique identifier for an event/action. UUIDv1 format. An edits/deletes of this event will need to use the same identifier.

entityId

A unique identifier for the entity/team that is performing this event/action. UUIDv1 format.

personId

A unique identifier for the person /team that is performing this event/action. UUIDv1 format. If the person is part of an entity/team that id field should also be included.

class

The class of the event - see above

eventType

The eventType of the event - see above

subType

The subType of the event - see above

options

The options for the event - see above

eventTime

An ISO-8601 datetime giving the time this event occurred. If this event is added out of sequence, then this timestamp should reflect when the event 'would' have occurred.

clock

The game clock time when this action occurred. Format ISO-8601 Duration.

shotClock

The game shot clock time when this action occurred. Format ISO-8601 Duration.

periodId

The unique identifier of the period. Overtime periods start at 11. 1 = 1 OT1 = 11

success

Boolean. Did the action complete successfully. It most cases this is true, however goal/shot attempts can be false.

The x-coordinate on the playing surface where the action occurred.

The y-coordinate on the playing surface where the action occurred.

The z-coordinate on the playing surface where the action occurred.

officialId

The unique identifier of the official who made this call.

playId

The unique identifier of the 'play' (a group of events who share this id).

scores

The structure of entityIds and scores giving the current score after the completion of the action.

status

The status of this message. Options are added (Default); updated - meaning the content of this event has been edited; deleted - meaning this event has been deleted; enriched - meaning further information has been added to the event (not changed).

flagged

Boolean. This event has been flagged for further review and may be changed later

highlight

Boolean. This event may be a highlight of the game.

timestamp

An ISO-8601 datetime giving the time this message was sent.

clientType

The type of client that is sending this event. Generally this is given as ApplicationName:ApplicationVersion.

If a field has no value it should not be sent as part of the message. If a field has no value then it should not be sent as part of the message. "" or 0 are valid values and should only be used when the value is known to be these values.

PreviousMessage Types Nextscoreboard

Last updated 3 hours ago

Was this helpful?

Good afternoon

class

eventType

subType

options