PlayHQ External API (1.0.0)

Download OpenAPI specification:Download

API Support: help@playhq.com URL: http://playhq.com/ License: Apache 2.0 Terms of Service

External API to exposing with playhq services.

Organisations

Lists all organisations

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number >= 0 Default: 1 Page Number to fetch data - the maximum value of this parameter will be equal to the totalPages in response metadata
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since
type	string One of CLUB, ASSOCIATION, ADMINISTRATIVE_BODY or ALL. Defaults to ALL

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"organisations": [{"id": "859d858a-6804-4848-ba4e-fc1105baab43",
"name": "SY MS AFL Club",
"nickname": "SYs",
"logoName": "https://assets.playhq.com/59d858/128_128_logo.png",
"termsAndConditionsUrl": "",
"type": "CLUB",
"taxStatus": "AUS_GST",
"visible": true,
"routingCode": "859d858a",
"createdAt": "2020-08-19T05:09:46.408000000Z",
"updatedAt": "2020-09-08T23:04:13.098000000Z",
"address": {"line1": "Apt 5, example street",
"suburb": "fitzroy",
"postcode": "3605",
"state": "VIC",
"country": "Australia"
},
"contact": {"contactName": "",
"contactNumber": "+611234567",
"telCountryCode": "61",
"email": "test@playhq.com",
"websiteUrl": "http://www.example.com"
}
}
]
},
"metadata": {"page": 4,
"totalPages": 36,
"totalRecords": 355
}
}

Organisation Created Webhook

Information about a new organisation

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "ORGANISATION.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "4b891d5d-31d3-4406-b917-dace774222f4",
"eventType": "ORGANISATION.CREATED",
"entityId": "d5daef02-2614-4cd6-ac51-87a5a3f4968e",
"eventRaisedDateTime": "2021-03-15T10:55:05.845Z",
"data": {"id": "d5daef02-2614-4cd6-ac51-87a5a3f4968e",
"parentId": "f715a356-1342-49be-8865-5595421994d0",
"logo": {"sizes": [{"url": null,
"dimensions": {"width": 32,
"height": 32
}
},
{"url": null,
"dimensions": {"width": 48,
"height": 48
}
},
{"url": null,
"dimensions": {"width": 128,
"height": 128
}
},
{"url": null,
"dimensions": {"width": 64,
"height": 64
}
},
{"url": null,
"dimensions": {"width": 96,
"height": 96
}
},
{"url": null,
"dimensions": {"width": 256,
"height": 256
}
}
]
},
"websiteUrl": null,
"eventRaisedDateTime": "2021-03-15T10:55:05.845Z",
"name": "Point Cook Auskick Centre",
"email": "pcac@afl.com",
"type": "CLUB",
"telCountryCode": 61,
"contactNumber": "0389712354",
"includeInFinder": false,
"formats": [ ],
"timezone": "Australia/Melbourne",
"visible": true,
"description": null,
"demographics": [ ],
"inclusions": [ ],
"contacts": [ ]
}
}

Organisation Updated Webhook

Information about an existing organisation which has been updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "ORGANISATION.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "b68c3b5f-3b03-4358-ab2a-aef39f170160",
"eventType": "ORGANISATION.UPDATED",
"entityId": "54668204-9ca1-4ea2-b5c2-461fea41a44d",
"eventRaisedDateTime": "2021-03-15T11:05:26.486Z",
"data": {"id": "54668204-9ca1-4ea2-b5c2-461fea41a44d",
"parentId": "f715a356-1342-49be-8865-5595421994d0",
"logo": null,
"websiteUrl": "http://www.pcac.afl.com",
"eventRaisedDateTime": "2021-03-15T11:05:26.486Z",
"name": "Point Cook Auskick Centre",
"email": "pcac@afl.com",
"type": "CLUB",
"telCountryCode": 61,
"contactNumber": "0389712354",
"includeInFinder": true,
"formats": [{"format": "AUSKICK",
"type": "PROGRAM"
},
{"format": "SCHOOLS",
"type": "PROGRAM"
},
{"format": "MULTICULTURAL",
"type": "PROGRAM"
},
{"format": "INDIGENOUS",
"type": "PROGRAM"
},
{"format": "HOLIDAY_PROGRAMS",
"type": "PROGRAM"
},
{"format": "COMMUNITY",
"type": "COMPETITION"
},
{"format": "AFL_9S",
"type": "COMPETITION"
}
],
"timezone": "Australia/Melbourne",
"visible": true,
"description": "This is a Test Description",
"demographics": [{"ageFrom": 2,
"ageTo": 10,
"gender": "MALE"
}
],
"address": {"line1": "21 Harding St",
"suburb": "Point Cook",
"state": "VIC",
"postcode": 3030,
"country": "Australia",
"latitude": -45,
"longitude": 68
},
"inclusions": ["ACCESS_FOR_ALL_ABILITIES_PLAY",
"FEMALE_ONLY_PARTICIPANTS"
],
"contacts": [{"id": "f93ea093-46f6-4bd3-8115-18f9d65db54a",
"organisationId": "54668204-9ca1-4ea2-b5c2-461fea41a44d",
"firstName": "Paul",
"lastName": "Jackson",
"position": "OPERATIONS_MANAGER",
"email": "paul.j@afl.com",
"phone": "0487234852",
"visible": true,
"sequenceNo": 1
},
{"id": "92820519-33d5-4162-b0da-46d30d03764d",
"organisationId": "54668204-9ca1-4ea2-b5c2-461fea41a44d",
"firstName": "John",
"lastName": "Smith",
"position": "ADMINISTRATOR",
"email": "john.s@afl.com",
"phone": 556082395,
"visible": true,
"sequenceNo": 0
}
]
}
}

Organisation Deleted Webhook

Information about an organisation which has been permanently deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "ORGANISATION.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "9beaf509-0278-44ba-b174-01dc27c2fa5d",
"eventType": "ORGANISATION.DELETED",
"entityId": "d5daef02-2614-4cd6-ac51-87a5a3f4968e",
"eventRaisedDateTime": "2021-03-15T10:59:16.910Z",
"data": {"id": "d5daef02-2614-4cd6-ac51-87a5a3f4968e",
"eventRaisedDateTime": "2021-03-15T10:59:16.910Z"
}
}

Competitions

Lists all competitions

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number >= 0 Default: 1 Page Number to fetch data - the maximum value of this parameter will be equal to the totalPages in response metadata
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"competitions": [{"id": "9ca6f5ce-7153-48c1-851d-5fdd1825c262",
"name": "CFA COMP",
"type": "DOMESTIC",
"visible": true,
"routingCode": "9ca6f5ce",
"organisationId": "b0d88e29-490b-4576-8c1f-d89c8c54238b",
"createdAt": "2020-07-23T23:09:59.736000000Z",
"updatedAt": "2020-07-23T23:09:59.736000000Z"
}
]
},
"metadata": {"page": 4,
"totalPages": 36,
"totalRecords": 355
}
}

Competition Created Webhook

Information about a new Competition

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "52adc80d-4373-4f04-bee0-00ebbb66617e",
"eventType": "COMPETITION.CREATED",
"entityId": "a0176d6a-1bb4-4d5e-8e64-784a2878ce45",
"eventRaisedDateTime": "2021-04-09T03:22:17.222Z",
"data": {"id": "a0176d6a-1bb4-4d5e-8e64-784a2878ce45",
"name": "ABA Comp DOM",
"type": "DOMESTIC",
"visible": true,
"organisationId": "b27bbcca-856f-4d08-94ae-5b3c0038ef38",
"format": "JUNIOR_DOMESTIC",
"eventRaisedDateTime": "2021-04-09T03:22:17.222Z"
}
}

Competition Updated Webhook

Information about an existing competition which has been updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "7860affe-5c69-4f5b-8fd7-bff5aec34720",
"eventType": "COMPETITION.UPDATED",
"entityId": "a0176d6a-1bb4-4d5e-8e64-784a2878ce45",
"eventRaisedDateTime": "2021-04-09T03:22:51.240Z",
"data": {"id": "a0176d6a-1bb4-4d5e-8e64-784a2878ce45",
"name": "ABA Comp DOM2",
"type": "DOMESTIC",
"visible": true,
"organisationId": "b27bbcca-856f-4d08-94ae-5b3c0038ef38",
"format": "SENIOR_DOMESTIC",
"eventRaisedDateTime": "2021-04-09T03:22:51.240Z"
}
}

Competition Deleted Webhook

Information about an competition which has been permanently deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "c9748113-02ed-4f92-8a78-66d76c11631a",
"eventType": "COMPETITION.DELETED",
"entityId": "4a635e4c-6bac-4133-958c-977d41aa2de4",
"eventRaisedDateTime": "2021-03-15T11:14:03.828Z",
"data": {"id": "4a635e4c-6bac-4133-958c-977d41aa2de4",
"eventRaisedDateTime": "2021-03-15T11:14:03.828Z"
}
}

Competition Seasons

Seasons for organisation

Retrieve a list of seasons for a specified association organisation.

path Parameters

required

string

ID of the organisation

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": [{"id": "11ed119a-cb8f-4faa-a338-cb714ba97a8c",
"name": 2021,
"status": "ACTIVE",
"association": {"id": "ccc647fa-286a-433b-8284-464c37d6f049",
"name": "Victorian Junior Basketball League (VJBL)",
"url": "https://www.playhq.com/basketball-victoria/org/victorian-junior-basketball-league-vjbl/08f42de2"
},
"logo": {"sizes": [{"url": "https://assets.playhq.com/bv/08f42d/64_64_logo.png",
"dimensions": {"width": 64,
"height": 64
}
}
]
},
"competition": {"id": "8e4e71fc-1f3e-4eba-9701-d5f361d2c269",
"name": "Victorian Junior Basketball League"
},
"createdAt": "2015-08-05T08:40:51.620Z",
"updatedAt": "2015-08-05T08:40:51.620Z"
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Teams for season

Retrieve a list of teams participating under a specified season.

path Parameters

required

string

ID of the season

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": [{"id": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"createdAt": "2015-08-05T08:40:51.620Z",
"updatedAt": "2015-08-05T08:40:51.620Z",
"club": {"id": "8ff76c62-ad92-4991-b160-9fe9d12476d2",
"name": "Keilor Thunder",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-basketball-club/ccc647fa",
"logo": {"sizes": [{"url": "https://assets.playhq.com/bv/ccc647/64_64_logo.png",
"dimensions": {"width": "string",
"height": "string"
}
}
]
}
},
"grade": {"id": "d1f9c41d-cb8f-4faa-a338-cb714ba97a8c",
"name": "12 Boys - VJL2 (P2)",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768"
}
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Grades for season

Retrieve a list of grades under a specified season.

path Parameters

required

string

ID of the season

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": [{"id": "d1f9c41d-cb8f-4faa-a338-cb714ba97a8c",
"name": "12 Boys - VJL2 (P2)",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768"
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Competition Season Created Webhook

Information about a new Competition Season Created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION_SEASON.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "d362f2c3-bb72-482e-af96-b4ea52f488a5",
"eventType": "COMPETITION_SEASON.CREATED",
"entityId": "30855249-a7fc-4d32-beb6-9f9495b00b4b",
"eventRaisedDateTime": "2022-06-29T18:57:39.976Z",
"data": {"id": "30855249-a7fc-4d32-beb6-9f9495b00b4b",
"eventRaisedDateTime": "2022-06-29T18:57:39.976Z",
"name": "Winter 2022",
"visible": true,
"competitionId": "2d880159-89d2-47b4-91da-195b4232a7d2",
"startDate": "2022-01-01T00:00:00.000Z",
"endDate": "2022-12-31T00:00:00.000Z",
"ageLimit": {"dateFrom": "2022-04-01T00:00:00.000Z",
"dateTo": "2022-04-30T00:00:00.000Z"
}
}
}

Competition Season Updated Webhook

Information about Competition Season Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION_SEASON.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "2b259f2b-a7f3-4397-a76b-f7c301a0fd5c",
"eventType": "COMPETITION_SEASON.UPDATED",
"entityId": "30855249-a7fc-4d32-beb6-9f9495b00b4b",
"eventRaisedDateTime": "2022-06-29T18:58:49.143Z",
"data": {"id": "30855249-a7fc-4d32-beb6-9f9495b00b4b",
"eventRaisedDateTime": "2022-06-29T18:58:49.143Z",
"name": "Winter 2022",
"visible": true,
"competitionId": "2d880159-89d2-47b4-91da-195b4232a7d2",
"startDate": "2022-01-01T00:00:00.000Z",
"endDate": "2022-12-31T00:00:00.000Z",
"ageLimit": {"dateFrom": "2022-04-01T00:00:00.000Z",
"dateTo": "2022-05-31T00:00:00.000Z"
}
}
}

Competition Season Deleted Webhook

Information about Competition Season Deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION_SEASON.DELETED"
	object

Request samples

Payload

Content type

application/json

{"messageId": "286cf97a-92a1-40d3-8d06-0adf06897851",
"eventType": "COMPETITION_SEASON.DELETED",
"entityId": "30855249-a7fc-4d32-beb6-9f9495b00b4b",
"eventRaisedDateTime": "2022-06-29T18:59:21.752Z",
"data": {"id": "30855249-a7fc-4d32-beb6-9f9495b00b4b",
"eventRaisedDateTime": "2022-06-29T18:59:21.752Z"
}
}

Club Admin Accepts Invite To Competition Season Webhook

Information about the accepted invitation to a Competition Season

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION_SEASON.CLUB_INVITED"
	object

Request samples

Payload

Content type

application/json

{"messageId": "3de99970-d754-4c7b-b8fe-31b4e5596fcd",
"eventType": "COMPETITION_SEASON.CLUB_INVITED",
"entityId": "35a091f8-bdf0-4aad-bb8a-b860cb433630",
"eventRaisedDateTime": "2021-03-15T11:20:35.973Z",
"data": {"seasonId": "35a091f8-bdf0-4aad-bb8a-b860cb433630",
"organisationId": "b5c3399a-e50d-4e69-a6a0-2180732c8119"
}
}

Competition Season Registration Forms

Competition Season Registration Form Created Webhook

Information about a Competition Season Registration Form Created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION_SEASON_REGISTRATION_FORM.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "41b04ad9-79d7-49b6-81bd-3e455e50a42e",
"eventType": "COMPETITION_SEASON_REGISTRATION_FORM.CREATED",
"entityId": "77f3b909-0715-4c28-b256-3e426f0cb315",
"eventRaisedDateTime": "2022-08-03T21:30:43.775Z",
"data": {"id": "77f3b909-0715-4c28-b256-3e426f0cb315",
"eventRaisedDateTime": "2022-08-03T21:30:43.775Z",
"type": "PARTICIPANT_TO_SEASON",
"competitionId": "930d5c5e-cc5e-4c00-9de2-4e8675c44b5b",
"seasonId": "072d8de8-c883-42df-8c28-622f0175da49",
"ownerId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"startDateTime": "2022-07-31T23:30:00.000Z",
"endDateTime": "2022-09-30T07:30:00.000Z",
"formUrl": "https://www.wizards.playhq.com/afl/register/192db7",
"visible": false,
"fees": [{"type": "Base",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "VOLUNTEER",
"amount": 0,
"description": "Association Volunteer Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
},
{"type": "Base",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "PLAYER",
"amount": 0,
"description": "Association Player Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
},
{"type": "Advanced",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "PLAYER",
"amount": 0,
"description": "Junior",
"ageAsAtDate": "1999-01-01T00:00:00.000Z",
"ageMin": 16,
"ageMax": 26,
"gender": "ALL"
},
{"type": "Base",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "TEAM_MANAGER",
"amount": 0,
"description": "Association Team Manager Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
}
],
"ageLimit": null,
"pricingInformation": "Season registration",
"additionalInformation": null
}
}

Competition Season Registration Form Updated Webhook

Information about a Competition Season Registration Form Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "COMPETITION_SEASON_REGISTRATION_FORM.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "ba233811-75f9-4915-90d0-8975176d6ca7",
"eventType": "COMPETITION_SEASON_REGISTRATION_FORM.UPDATED",
"entityId": "42235e57-5f77-42d6-bc0c-52810fdff607",
"eventRaisedDateTime": "2022-08-03T21:26:34.544Z",
"data": {"id": "42235e57-5f77-42d6-bc0c-52810fdff607",
"eventRaisedDateTime": "2022-08-03T21:26:34.544Z",
"type": "PARTICIPANT_TO_SEASON",
"competitionId": "24858763-e372-4db2-85ad-d87210de6b73",
"seasonId": "85fd35c7-3a89-4b22-aa0c-07290a3198bc",
"ownerId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"startDateTime": "2021-12-31T22:30:00.000Z",
"endDateTime": "2022-12-31T06:30:00.000Z",
"formUrl": "https://www.wizards.playhq.com/afl/register/39c4a4",
"visible": true,
"fees": [{"type": "Variant",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "PLAYER",
"amount": 0,
"description": "Junior Player Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
},
{"type": "Base",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "TEAM_MANAGER",
"amount": 0,
"description": "Association Team Manager Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
},
{"type": "Base",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "VOLUNTEER",
"amount": 0,
"description": "Association Volunteer Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
},
{"type": "Base",
"orgId": "cd4ca8ec-4fcd-4f79-b151-a580fd74ddb6",
"role": "PLAYER",
"amount": 0,
"description": "Association Player Registration Fee",
"ageAsAtDate": null,
"ageMin": null,
"ageMax": null,
"gender": null
}
],
"ageLimit": null,
"pricingInformation": "Season Registration for Junior (kids 12 and under) $200 & Season Registrations for Seniors are $300",
"additionalInformation": "Junior Grades play Saturday mornings and Open Age Domestic grades are offered for Monday",
"Wednesdays or Fridays": null
}
}

Competition Season Registrations

Competition Registrations Webhook

Information about a Competition Registrations

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Enum: "COMPETITION_REGISTRATION_TO_SEASON.CREATED" "COMPETITION_REGISTRATION_TO_CLUB.CREATED" "COMPETITION_REGISTRATION_TO_TEAM.CREATED" "COMPETITION_REGISTRATION_TO_CLUB_TEAM.CREATED" "COMPETITION_REGISTRATION.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "18f6066d-ea1c-47e4-93cc-80759a50a67c",
"eventType": "COMPETITION_REGISTRATION_TO_SEASON.CREATED",
"entityId": "ec34a007-3d6d-4b4d-ae82-660642ea914c",
"eventRaisedDateTime": "2022-08-09T14:56:11.694Z",
"data": {"id": "58de64e4-a366-49bb-a154-683d6322c214",
"eventRaisedDateTime": "2022-08-09T14:56:11.694Z",
"profile": {"id": "cdb3789a-5e83-4b5d-b7e7-82a8b5f2aabd",
"accountHolder": false,
"accountHolderProfileId": "cb764b2e-b747-4090-ac0e-5b214bf3ec40",
"accountHolderEmailAddress": "denis.strelnik@playhq.com",
"accountHolderMobileCountryCode": 61,
"accountHolderMobile": 411222333,
"accountHolderExternalAccountId": "3945d99d4fae487887daec660ddc395e",
"participant": {"firstName": "Alisa",
"lastName": "Rosales",
"dateOfBirth": "1991-08-23T00:00:00.000Z",
"gender": "NON_BINARY",
"address": "535 Green Second Court",
"suburb": "Bimd",
"postcode": 7180,
"state": "NT",
"country": "Australia",
"emailAddress": "",
"mobilePhone": "",
"mobileCountryCode": null
},
"profileVisible": true,
"parentGuardiansBornOverseas": "NOT_SAYING",
"parentGuardian1CountryOfBirth": "",
"parentGuardian2CountryOfBirth": "",
"hasDisability": "NOT_SAYING",
"disabilities": [ ],
"otherDisabilityDescription": "",
"additionalDisabilitySupportInformation": "",
"atsi": "NOT_SAYING",
"parentGuardians": [{"firstName": "Denis",
"lastName": "Strelnik",
"mobileNumber": 411222333,
"mobileCountryCode": 61,
"emailAddress": "denis.strelnik@playhq.com",
"address": "950 Hague Drive",
"suburb": "Jadf",
"postcode": 1573,
"state": "ACT",
"country": "Australia"
}
],
"emergencyContact": {"firstName": "test",
"lastName": "test",
"mobile": 76695844,
"mobileCountryCode": 61,
"emailAddress": "cuhoheb@mailinator.com",
"relationship": "friend"
},
"createdAt": "2022-08-09T14:55:54.000Z",
"updatedAt": "2022-08-09T14:56:11.000Z",
"externalAccountId": null
},
"registration": {"id": "ec34a007-3d6d-4b4d-ae82-660642ea914c",
"participantProfileId": "cdb3789a-5e83-4b5d-b7e7-82a8b5f2aabd",
"competitionRegisteredToId": "af24f9e6-98ef-4a6a-8a5f-4a853942e6b7",
"organisationRegisteredToId": "2afd5fe5-8c24-44f1-aaf9-dbd978c55aee",
"seasonRegisteredToId": "104db3db-3a03-4af9-86cd-d4c6ad11d22c",
"teamRegisteredToId": null,
"teamName": null,
"seasonStartDate": "2022-05-01T00:00:00.000Z",
"seasonEndDate": "2022-12-31T00:00:00.000Z",
"registrationDate": "2022-08-09T14:55:54.813Z",
"role": "Player",
"registrationStatus": "REGISTERED",
"participantDateOfBirth": "1991-08-23T00:00:00.000Z",
"participantGender": "Non-Binary",
"schoolID": null,
"schoolYear": null,
"optInMarketing": false,
"createdAt": "2022-08-09T14:55:54.813Z",
"updatedAt": "2022-08-09T14:55:54.813Z"
}
}
}

Teams

Lists all teams

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number >= 0 Default: 1 Page Number to fetch data - the maximum value of this parameter will be equal to the totalPages in response metadata
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"teams": [{"id": "007ce472-bb0d-4e84-b5cb-f88335e0a34e",
"orgid": "e86d026f-3f9d-463e-a300-9db067917dfa",
"name": "U12 Team A",
"gender": "BOYS",
"ageGroup": "U12",
"preferredGrade": "ABC",
"teamIdentifier": "U12TA",
"routingCode": "007ce472",
"createdAt": "2020-08-10T23:14:21.938000000Z",
"updatedAt": "2020-08-10T23:14:21.938000000Z"
}
]
},
"metadata": {"page": 4,
"totalPages": 36,
"totalRecords": 355
}
}

Fixture for team

Retrieve a list of games and related fixture information per specified team. Please note, this API is not applicable to Cricket

path Parameters

required

string

ID of the team

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": [{"id": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"status": "UPCOMING",
"url": "https://www.playhq.com/basketball-victoria/org/jg_association2/domestic-winter-2021/monday-u10-mixed/game-centre/91e4cde3",
"createdAt": "2015-08-05T08:40:51.620Z",
"updatedAt": "2015-08-05T08:40:51.620Z",
"grade": {"id": "d1f9c41d-cb8f-4faa-a338-cb714ba97a8c",
"name": "12 Boys - VJL2 (P2)",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768"
},
"round": {"id": "a93c2389-b361-4af1-95f1-a758900fb018",
"name": "Round 1",
"abbreviatedName": "R1",
"isFinalRound": false
},
"pool": null,
"schedule": {"date": "2015-08-05T00:00:00.000Z",
"time": "08:40:51",
"timezone": "Australia/Melbourne"
},
"competitors": [{"id": "95c446ef-dea5-486e-96bb-1bb24a609177",
"name": "Keilor U12 Boys 2",
"isHomeTeam": true,
"outcome": "WON",
"scoreTotal": 47,
"scoreSubTotal": [{"type": "GOALS_TOTAL",
"count": 2,
"value": 12
},
{"type": "BEHINDS_TOTAL",
"count": 2,
"value": 2
}
]
},
{"id": "0ed2c665-1a3e-4cd6-8448-22bef74e54b6",
"name": "Diamond Valley U12 Boys 2",
"isHomeTeam": false,
"outcome": "LOST",
"scoreTotal": 46,
"scoreSubTotal": [{"type": "GOALS_TOTAL",
"count": 4,
"value": 24
},
{"type": "BEHINDS_TOTAL",
"count": 7,
"value": 7
}
]
}
],
"venue": {"id": "eccf8810-7d57-4ffd-bb48-9418e3eb93ac",
"name": "Keilor Basketball Netball Stadium",
"surfaceName": "Court 1",
"surfaceAbbreviation": "CRT1",
"address": {"line1": "Stadium Dr",
"suburb": "Keilor Park",
"postcode": 3042,
"state": "VIC",
"country": "AU",
"latitude": -37.713286,
"longitude": 144.848203
}
}
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Teams for organisation

Retrieve a list of teams for a specified association organisation.

path Parameters

required

string

ID of the organisation

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": [{"id": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"name": "Keilor U12 Boys 2",
"createdAt": "2015-08-05T08:40:51.620Z",
"updatedAt": "2015-08-05T08:40:51.620Z",
"club": {"id": "8ff76c62-ad92-4991-b160-9fe9d12476d2",
"name": "Keilor Thunder",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-basketball-club/ccc647fa",
"logo": {"sizes": [{"url": "https://assets.playhq.com/bv/ccc647/64_64_logo.png",
"dimensions": {"width": "string",
"height": "string"
}
}
]
}
},
"association": {"id": "ccc647fa-286a-433b-8284-464c37d6f049",
"name": "Victorian Junior Basketball League (VJBL)",
"url": "https://www.playhq.com/basketball-victoria/org/victorian-junior-basketball-league-vjbl/08f42de2",
"logo": {"size": [{"url": "https://assets.playhq.com/bv/08f42d/64_64_logo.png",
"dimensions": {"width": 64,
"height": 64
}
}
]
}
},
"competition": {"id": "8e4e71fc-1f3e-4eba-9701-d5f361d2c269",
"name": "Victorian Junior Basketball League"
},
"season": {"id": "11ed119a-cb8f-4faa-a338-cb714ba97a8c",
"name": 2021,
"status": "ACTIVE",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-basketball-association/junior-domestic-winter-2021/8e4e71fc"
},
"grade": {"id": "d1f9c41d-cb8f-4faa-a338-cb714ba97a8c",
"name": "12 Boys - VJL2 (P2)",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768"
}
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Team Created Webhook

Information about a Team Created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "TEAM.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "d0bf7491-9b8e-46da-bc7d-27351e36122b",
"eventType": "TEAM.CREATED",
"entityId": "f10b9adf-9f70-46a6-a40c-8e5ba80f46eb",
"eventRaisedDateTime": "2022-08-23T20:01:19.498Z",
"data": {"id": "f10b9adf-9f70-46a6-a40c-8e5ba80f46eb",
"seasonId": "6de92c2e-8a90-4b98-8dae-4173c27b2efb",
"gradeId": null,
"ageGroup": "U21",
"gender": "MIXED",
"teamIdentifier": null,
"teamName": "Team A - Boys U21_1",
"teamOriginId": "e38cae17-a7b0-487f-b4c6-820eaf5674fe",
"organisationId": "a7d275a0-a8e8-4f3a-b2a9-a00a42d681e5",
"eventRaisedDateTime": "2022-08-23T20:01:19.498Z",
"rolloverSourceId": "732d1698-07de-4759-b1c3-f81716c0a39a"
}
}

Team Updated Webhook

Information about a Team Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "TEAM.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "bd977e4c-34a5-432b-b2ec-7803432ceb0b",
"eventType": "TEAM.UPDATED",
"entityId": "f10b9adf-9f70-46a6-a40c-8e5ba80f46eb",
"eventRaisedDateTime": "2022-08-23T20:03:59.873Z",
"data": {"id": "f10b9adf-9f70-46a6-a40c-8e5ba80f46eb",
"seasonId": "6de92c2e-8a90-4b98-8dae-4173c27b2efb",
"gradeId": "9a74b0d5-6078-4784-9695-822b5a191ed8",
"ageGroup": "INTERMEDIATE",
"gender": "MIXED",
"teamIdentifier": "Tigers",
"teamName": "Team A - Boys U21",
"teamOriginId": "e38cae17-a7b0-487f-b4c6-820eaf5674fe",
"organisationId": "a7d275a0-a8e8-4f3a-b2a9-a00a42d681e5",
"eventRaisedDateTime": "2022-08-23T20:03:59.873Z",
"rolloverSourceId": "732d1698-07de-4759-b1c3-f81716c0a39a"
}
}

Team Deleted Webhook

Information about a Team Deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "TEAM.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "3218b826-b8e8-4ebf-ba0c-77f0b623358f",
"eventType": "TEAM.DELETED",
"entityId": "f10b9adf-9f70-46a6-a40c-8e5ba80f46eb",
"eventRaisedDateTime": "2022-08-23T20:05:13.302Z",
"data": {"id": "f10b9adf-9f70-46a6-a40c-8e5ba80f46eb",
"eventRaisedDateTime": "2022-08-23T20:05:13.302Z"
}
}

Grades

Lists all grades

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number >= 0 Default: 1 Page Number to fetch data - the maximum value of this parameter will be equal to the totalPages in response metadata
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"grades": [{"id": "499b8020-d300-4928-90d7-9592ce6aba3b",
"age": "U9",
"name": "Tuesday U9 Boys",
"day": "TUESDAY",
"division": "S",
"gender": "BOYS",
"startDate": "2020-06-03",
"periodType": "HALVES",
"visible": true,
"createdAt": "2020-08-18T00:53:20.659000000Z",
"updatedAt": "2020-08-18T00:53:20.659000000Z",
"season": {"id": "b620ddc7-83b1-4d63-864a-116b867b22db",
"name": "Winter 2020"
},
"competition": {"id": "cd52d33d-a24f-465e-8661-5038dadc5187",
"name": "JUNIOR DOMESTIC COMP"
}
}
]
}
}

Fixture for grade

Retrieve a list of games and related fixture information under a specified grade. Please note, this API version has been deprecated and is not applicable to Cricket. Please refer to the v2 of this API.

path Parameters

required

string

ID of the grade

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": [{"id": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"status": "UPCOMING",
"url": "https://www.playhq.com/basketball-victoria/org/jg_association2/domestic-winter-2021/monday-u10-mixed/game-centre/91e4cde3",
"createdAt": "2015-08-05T08:40:51.620Z",
"updatedAt": "2015-08-05T08:40:51.620Z",
"round": {"id": "a93c2389-b361-4af1-95f1-a758900fb018",
"name": "Round 1",
"abbreviatedName": "R1",
"isFinalRound": false
},
"pool": {"id": "d2fb442d-cebb-4fe3-ac2d-33e1a5f1055d",
"name": "Pool A"
},
"schedule": {"date": "2015-08-05T00:00:00.000Z",
"time": "08:40:51",
"timezone": "Australia/Melbourne"
},
"competitors": [{"id": "95c446ef-dea5-486e-96bb-1bb24a609177",
"name": "Keilor U12 Boys 2",
"isHomeTeam": true,
"outcome": "WON",
"scoreTotal": 47,
"scoreSubTotal": [{"type": "BEHINDS_TOTAL",
"count": 2,
"value": 12
},
{"type": "GOALS_TOTAL",
"count": 2,
"value": 2
}
]
},
{"id": "0ed2c665-1a3e-4cd6-8448-22bef74e54b6",
"name": "Diamond Valley U12 Boys 2",
"isHomeTeam": false,
"outcome": "LOST",
"scoreTotal": 46,
"scoreSubTotal": [{"type": "BEHINDS_TOTAL",
"count": 3,
"value": 18
},
{"type": "GOALS_TOTAL",
"count": 7,
"value": 7
}
]
}
],
"venue": {"id": "eccf8810-7d57-4ffd-bb48-9418e3eb93ac",
"name": "Keilor Basketball Netball Stadium",
"surfaceName": "Court 1",
"surfaceAbbreviation": "CRT1",
"address": {"line1": "Stadium Dr",
"suburb": "Keilor Park",
"postcode": 3042,
"state": "VIC",
"country": "AU",
"latitude": -37.713286,
"longitude": 144.848203
}
}
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Fixture for grade V2

Retrieve a list of games and related fixture information under a specified grade.

path Parameters

required

string

ID of the grade

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"rounds": [{"id": "1b34d1d0-ad1d-4afb-a3c5-809442e49208",
"name": "Round 1",
"abbreviatedName": "R1",
"isFinalRound": false,
"byes": [{"teamID": "2f6eafeb-4ef8-4e75-a99c-7ce8860319bb"
}
],
"games": [{"id": "e606f2c3-d4cf-4edb-a204-e6a738df545e",
"status": "FINAL",
"type": "T20",
"url": "https://playhq.com/cricket-australia/org/deniss-association/tournament-test-winter-2022/over-40-men/game-centre/e606f2c3",
"createdAt": "2022-01-13T14:21:06.706Z",
"updatedAt": "2022-01-13T19:24:50.322Z",
"pool": {"id": "bf1d7db4-fe60-4a5b-bf15-be9e5d24e66b",
"name": "Pool A"
},
"schedule": [{"day": null,
"dateTime": "2022-01-03T21:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"isHomeTeam": true,
"outcome": "WON_BY_SUPER_OVER"
},
{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"isHomeTeam": false,
"outcome": "LOSS_BY_SUPER_OVER"
}
],
"periods": [{"name": "AWAY_TEAM_FIRST_INNINGS",
"sequenceNo": 1,
"teams": [{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"discipline": "BATTING",
"outcome": {"status": "ALL_OUT",
"statistics": [{"type": "TOTAL_OVERS",
"value": 1
},
{"type": "TOTAL_SCORE",
"value": 1
},
{"type": "TOTAL_OUTS",
"value": 1
}
]
}
},
{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"discipline": "BOWLING",
"outcome": {"status": null,
"statistics": [ ]
}
}
]
},
{"name": "HOME_TEAM_FIRST_INNINGS",
"sequenceNo": 2,
"teams": [{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"discipline": "BATTING",
"outcome": {"status": "ALL_OUT",
"statistics": [{"type": "TOTAL_OVERS",
"value": 1
},
{"type": "TOTAL_SCORE",
"value": 1
},
{"type": "TOTAL_OUTS",
"value": 1
}
]
}
},
{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"discipline": "BOWLING",
"outcome": {"status": null,
"statistics": [ ]
}
}
]
},
{"name": "AWAY_TEAM_OVERTIME",
"sequenceNo": 3,
"teams": [{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"discipline": "BATTING",
"outcome": {"status": "ALL_OUT",
"statistics": [{"type": "TOTAL_OVERS",
"value": 4
},
{"type": "TOTAL_SCORE",
"value": 1
},
{"type": "TOTAL_OUTS",
"value": 1
}
]
}
},
{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"discipline": "BOWLING",
"outcome": {"status": null,
"statistics": [ ]
}
}
]
},
{"name": "HOME_TEAM_OVERTIME",
"sequenceNo": 4,
"teams": [{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"discipline": "BATTING",
"outcome": {"status": "END_OF_GAME",
"statistics": [{"type": "TOTAL_OVERS",
"value": 6
},
{"type": "TOTAL_SCORE",
"value": 6
},
{"type": "TOTAL_OUTS",
"value": 1
}
]
}
},
{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"discipline": "BOWLING",
"outcome": {"status": null,
"statistics": [ ]
}
}
]
}
],
"match": null
}
]
},
{"id": "7bdc6979-5f13-4e97-9d26-16b8849bd452",
"name": "Round 2",
"abbreviatedName": "R2",
"isFinalRound": false,
"byes": [{"teamID": "2f6eafeb-4ef8-4e75-a99c-7ce8860319bb"
}
],
"games": [{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"status": "PENDING",
"type": "twoDay",
"url": "https://playhq.com/cricket-australia/org/deniss-association/tournament-test-winter-2022/over-40-men/game-centre/80210dad",
"createdAt": "2022-01-13T14:21:06.856Z",
"updatedAt": "2022-01-13T14:21:06.856Z",
"pool": {"id": "bf1d7db4-fe60-4a5b-bf15-be9e5d24e66b",
"name": "Pool A"
},
"schedule": [{"day": 1,
"dateTime": "2022-01-10T21:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
},
{"day": 2,
"dateTime": "2022-01-11T21:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"isHomeTeam": false,
"outcome": null
},
{"id": "2f6eafeb-4ef8-4e75-a99c-7ce8860319bb",
"isHomeTeam": true,
"outcome": null
}
],
"periods": null,
"match": null
}
]
}
],
"teams": [{"id": "d3d78789-31b2-498a-a24d-3a76502acd94",
"name": "A_O40"
},
{"id": "ac7d49c2-c539-4b61-a447-20559ca28562",
"name": "B_O40"
},
{"id": "2f6eafeb-4ef8-4e75-a99c-7ce8860319bb",
"name": "C_O40"
}
],
"playingSurfaces": [{"id": "2776ade6-542e-409d-b5fc-523ca2ffeeca",
"name": "Test ground",
"abbreviatedName": "TG",
"longitude": 43,
"latitude": 23,
"venue": {"id": "07d92eb8-28f0-4354-ba5a-7549ecb54250",
"name": "Denis's Venue",
"timezone": "Australia/Melbourne",
"address": {"line1": null,
"suburb": "COOKTOWN",
"postcode": 4895,
"state": "QLD",
"country": "Australia",
"latitude": 23,
"longitude": 44
}
}
}
]
}

Ladder for grade

Retrieve a list of ladder related information per specified grade. Please note, this API version has been deprecated and is not applicable to Cricket. Please refer to the v2 of this API.

path Parameters

required

string

ID of the grade

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": {"grade": {"id": "9026440a-41e9-4c75-9eb5-7f2860f29fbb"
},
"ladders": [{"pool": {"id": "d2fb442d-cebb-4fe3-ac2d-33e1a5f1055d",
"name": "Pool A"
},
"standings": [{"team": null,
"id": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"name": "Keilor U12 Boys 2",
"played": 0,
"won": 0,
"lost": 0,
"drawn": "0,",
"byes": "0,",
"pointsFor": "00.00,",
"pointsAgainst": "00.00,",
"forfeits": "0,",
"disqualifications": "0,",
"adjustments": "00.00,",
"percentage": "00.00,",
"competitionPoints": "0,",
"pointsAverage": "0,",
"ranking": 1
}
]
}
]
}
}

Ladder for grade V2

Retrieve a list of ladder related information per specified grade.

path Parameters

required

string

ID of the grade

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"gradeId": "33063bcc-f45e-4cba-afce-de43bec58165",
"ladders": [{"headers": [{"key": "played",
"name": "Played",
"shortName": "P"
},
{"key": "pointsAverage",
"name": "Points average",
"shortName": "PTS AVG"
},
{"key": "won",
"name": "Won",
"shortName": "W"
},
{"key": "lost",
"name": "Lost",
"shortName": "L"
}
],
"pool": {"id": "49084ee6-7904-4307-9fb5-928204171a92",
"name": "Pool A"
},
"standings": [{"team": {"id": "69084ee6-7904-4307-9fb5-928204171a98",
"name": "a"
},
"values": [5,
12.5,
3,
2
]
},
{"team": {"id": "53264d94-4bf4-47d6-8762-75f8cf3275c9",
"name": "b"
},
"values": [5,
8.2,
2,
3
]
}
],
"type": "t20"
},
{"headers": [{"key": "played",
"name": "Played",
"shortName": "P"
},
{"key": "pointsAverage",
"name": "Points average",
"shortName": "PTS AVG"
},
{"key": "won",
"name": "Won",
"shortName": "W"
},
{"key": "lost",
"name": "Lost",
"shortName": "L"
}
],
"pool": {"id": "96484ee6-7904-4307-9fb5-928204171a92",
"name": "Pool B"
},
"standings": [{"team": {"id": "69084ee6-7904-4307-9fb5-928204171a98",
"name": "a"
},
"values": [4,
5,
2,
2
]
},
{"team": {"id": "53264d94-4bf4-47d6-8762-75f8cf3275c9",
"name": "b"
},
"values": [4,
7.1,
4,
0
]
}
],
"type": "twoDay"
},
{"headers": [{"key": "played",
"name": "Played",
"shortName": "P"
},
{"key": "pointsAverage",
"name": "Points average",
"shortName": "PTS AVG"
},
{"key": "won",
"name": "Won",
"shortName": "W"
},
{"key": "lost",
"name": "Lost",
"shortName": "L"
}
],
"pool": null,
"standings": [{"team": {"id": "69084ee6-7904-4307-9fb5-928204171a98",
"name": "a"
},
"values": [10,
6.2,
5,
5
]
},
{"team": {"id": "53264d94-4bf4-47d6-8762-75f8cf3275c9",
"name": "b"
},
"values": [10,
1.4,
1,
9
]
}
],
"type": "oneDay"
}
]
}

Player Stats by Grade V1

Retrieve a list of player statistics under a specified grade. Please note, this API is not applicable to Cricket at present.

path Parameters

required

string

ID of the grade

query Parameters

sort	string Enum: "10_POINT_SCORE" "1_POINT_SCORE" "2_POINT_SCORE" "3_POINT_SCORE" "6_POINT_SCORE" "9_POINT_SCORE" "APPEARANCE" "BENCH_TECHNICAL_FOUL" "BEST_PLAYER" "DISQUALIFYING_FOUL" "GOAL_COUNT" "PERSONAL_FOUL" "RED_CARD" "TECHNICAL_FOUL" "TOTAL_BEHINDS" "TOTAL_FOULS" "TOTAL_GOALS" "TOTAL_SCORE" "UNSPORTSMANLIKE_FOUL" "YELLOW_CARD" Statstic by which players will be sorted (descending)
limit	string Number of players to be returned
cursor	string Optional. If a response has `metadata.hasMore == true`, set this parameter to `metadata.nextCursor` to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": {"profileTeams": [{"profileId": "1f2b7615-d63a-4c66-906c-e76a53a11b7b",
"teamId": "07c351c5-e7c9-471c-b144-b3e78d3ea0e7",
"statistics": [{"value": "GP",
"count": 8
},
{"value": "YEL",
"count": 1
},
{"value": "RED",
"count": 0
},
{"value": "G",
"count": 23
},
{"value": "P",
"count": 1
}
]
},
{"profileId": "f0adb421-e338-4ce0-a807-a44ee051c97f",
"teamId": "38bb233f-a083-4541-b556-1b781cbf9d26",
"statistics": [{"value": "GP",
"count": 9
},
{"value": "YEL",
"count": 1
},
{"value": "RED",
"count": 0
},
{"value": "G",
"count": 20
},
{"value": "P",
"count": 1
}
]
},
{"profileId": "f0adb421-e338-4ce0-a807-a44ee051c97f",
"teamId": "82c3137b-8279-412e-b33f-74ed16319bfe",
"statistics": [{"value": "GP",
"count": 7
},
{"value": "YEL",
"count": 1
},
{"value": "RED",
"count": 0
},
{"value": "G",
"count": 21
},
{"value": "P",
"count": 1
}
]
}
],
"profiles": [{"id": "1f2b7615-d63a-4c66-906c-e76a53a11b7b",
"firstName": "Billy",
"lastName": "Campbell"
},
{"id": "f0adb421-e338-4ce0-a807-a44ee051c97f",
"firstName": "Aaron",
"lastName": "Coleman"
}
],
"teams": [{"id": "82c3137b-8279-412e-b33f-74ed16319bfe",
"name": "U10 Boys Team 1"
},
{"id": "07c351c5-e7c9-471c-b144-b3e78d3ea0e7",
"name": "U10 Boys Team 3"
},
{"id": "38bb233f-a083-4541-b556-1b781cbf9d26",
"name": "U10 Boys Team 5"
}
]
},
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Grade Created Webhook

Information about a Grade Created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "GRADE.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "25f417b8-7d85-483c-b6b4-a161f16eadac",
"eventType": "GRADE.CREATED",
"entityId": "6767511a-e330-48a9-9b5b-3b519907c674",
"eventRaisedDateTime": "2022-04-29T09:03:28.700Z",
"data": {"id": "6767511a-e330-48a9-9b5b-3b519907c674",
"seasonID": "85fd35c7-3a89-4b22-aa0c-07290a3198bc",
"day": "MONDAY",
"ageGroup": "U16",
"gender": "MIXED",
"division": null,
"gradeName": "Monday U16 Mixed",
"visible": true,
"lastVisibleRound": null,
"hideScores": false,
"lineupPublishing": {"type": "GAME_START"
},
"eventRaisedDateTime": "2022-04-29T09:03:28.700Z",
"rolloverSourceId": "732d1698-07de-4759-b1c3-f81716c0a39a"
}
}

Grade Updated Webhook

Information about a Grade Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "GRADE.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "824a60b7-0d9d-4d5a-852a-bbec094f0983",
"eventType": "GRADE.UPDATED",
"entityId": "732d1698-07de-4759-b1c3-f81716c0a39a",
"eventRaisedDateTime": "2022-04-29T00:55:23.948Z",
"data": {"id": "732d1698-07de-4759-b1c3-f81716c0a39a",
"seasonID": "9a7c350e-b387-4365-b394-d534f55dee9d",
"day": "MONDAY",
"ageGroup": "JUNIOR",
"gender": "MIXED",
"division": null,
"gradeName": "Monday Junior Mixed",
"visible": true,
"lastVisibleRound": "Round 10",
"hideScores": true,
"lineupPublishing": {"type": "BEFORE_GAME_START",
"beforeGameStartHours": 4,
"lineupRemainsWhenGameStarted": true
},
"eventRaisedDateTime": "2022-04-29T00:55:23.948Z",
"rolloverSourceId": "732d1698-07de-4759-b1c3-f81716c0a39a"
}
}

Grade Deleted Webhook

Information about a Grade Deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "GRADE.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"entityId": "a77bee3c-30f2-11ec-8d3d-0242ac130003",
"eventRaisedDateTime": "2021-04-13T07:52:58.650Z",
"eventType": "GRADE.DELETED",
"data": {"id": "42995efa-9dd8-4d22-bdca-a1abc4b4e7cc",
"eventRaisedDateTime": "2021-04-13T07:52:58.650Z"
}
}

Grade Fixture Created Webhook

Information about a Grade Fixture Created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "GRADE_FIXTURE.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "639b0ca4-8c9d-4268-a74a-fc5bfb464654",
"eventType": "GRADE_FIXTURE.CREATED",
"entityId": "5b598b88-f1e1-44b1-a98e-0f6bba1dd1f0",
"eventRaisedDateTime": "2022-05-19T11:38:25.123Z",
"data": {"id": "5b598b88-f1e1-44b1-a98e-0f6bba1dd1f0",
"rounds": [{"id": "8f28244e-3de6-4009-8e6e-4473c7d7b382",
"name": "Round 1",
"abbreviatedName": "R1",
"byes": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e"
}
],
"isFinalRound": false,
"games": [{"id": "b1e80a3f-a284-4212-b69d-96568404a1b3",
"status": "PENDING",
"type": "t20",
"createdAt": "2022-05-19T11:38:25.016Z",
"updatedAt": "2022-05-19T11:38:25.016Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-04T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": false
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"isHomeTeam": true
}
]
}
]
},
{"id": "5307a0b6-e129-48c7-b683-0f0b34cb87e2",
"name": "Round 2",
"abbreviatedName": "R2",
"byes": [{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5"
}
],
"isFinalRound": false,
"games": [{"id": "557cb53a-5e3a-42b8-9c00-59478b5bdf35",
"status": "PENDING",
"type": "t20",
"createdAt": "2022-05-19T11:38:25.059Z",
"updatedAt": "2022-05-19T11:38:25.059Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-11T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"isHomeTeam": true
},
{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": false
}
]
}
]
},
{"id": "85c530db-406e-4915-897b-24c60ae62622",
"name": "Round 3",
"abbreviatedName": "R3",
"byes": [{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179"
}
],
"isFinalRound": false,
"games": [{"id": "6837b817-7556-4911-888e-7cec2fdfba99",
"status": "PENDING",
"type": "oneDay",
"createdAt": "2022-05-19T11:38:25.066Z",
"updatedAt": "2022-05-19T11:38:25.066Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-18T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"isHomeTeam": true
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"isHomeTeam": false
}
]
}
]
},
{"id": "cb45df21-c2f9-4b2d-a448-27c600564a66",
"name": "Round 4",
"abbreviatedName": "R4",
"byes": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e"
}
],
"isFinalRound": false,
"games": [{"id": "cd1aa3cf-d2ea-47ee-a2f5-78e878f638fd",
"status": "UPCOMING",
"type": "oneDay",
"createdAt": "2022-05-19T11:38:25.078Z",
"updatedAt": "2022-05-19T11:38:25.078Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-25T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": true
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"isHomeTeam": false
}
]
}
]
},
{"id": "f4abcd18-fb7c-466f-ad41-297b68b96025",
"name": "Round 5",
"abbreviatedName": "R5",
"byes": [{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5"
}
],
"isFinalRound": false,
"games": [{"id": "6aa0081d-3b32-402e-b715-f250c3171b77",
"status": "UPCOMING",
"type": "oneDay",
"createdAt": "2022-05-19T11:38:25.085Z",
"updatedAt": "2022-05-19T11:38:25.085Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-06-01T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"isHomeTeam": false
},
{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": true
}
]
}
]
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"name": "C"
},
{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"name": "A"
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"name": "B"
}
],
"playingSurfaces": [{"id": "2776ade6-542e-409d-b5fc-523ca2ffeeca",
"name": "Test ground 1",
"abbreviatedName": "TG_1",
"latitude": 23,
"longitude": 43,
"venue": {"id": "07d92eb8-28f0-4354-ba5a-7549ecb54250",
"name": "Denis's Cricket Ground",
"address": {"line1": "FERRARI ESTATE",
"126 CHARLOTTE ST": null,
"suburb": "COOKTOWN",
"postcode": 4895,
"state": "QLD",
"country": "Australia",
"longitude": 44,
"latitude": 23
},
"timezone": "Australia/Melbourne"
}
}
]
}
}

Grade Fixture Updated Webhook

Information about a Grade Fixture Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "GRADE_FIXTURE.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "d1d069ea-24c7-4f39-9cb9-6708dd705fb6",
"eventType": "GRADE_FIXTURE.UPDATED",
"entityId": "5b598b88-f1e1-44b1-a98e-0f6bba1dd1f0",
"eventRaisedDateTime": "2022-05-19T11:38:25.675Z",
"data": {"id": "5b598b88-f1e1-44b1-a98e-0f6bba1dd1f0",
"rounds": [{"id": "8f28244e-3de6-4009-8e6e-4473c7d7b382",
"name": "Round 1",
"abbreviatedName": "R1",
"byes": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e"
}
],
"isFinalRound": false,
"games": [{"id": "b1e80a3f-a284-4212-b69d-96568404a1b3",
"status": "PENDING",
"type": "t20",
"createdAt": "2022-05-19T11:38:25.016Z",
"updatedAt": "2022-05-19T11:38:25.016Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-04T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": false
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"isHomeTeam": true
}
]
}
]
},
{"id": "5307a0b6-e129-48c7-b683-0f0b34cb87e2",
"name": "Round 2",
"abbreviatedName": "R2",
"byes": [{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5"
}
],
"isFinalRound": false,
"games": [{"id": "557cb53a-5e3a-42b8-9c00-59478b5bdf35",
"status": "PENDING",
"type": "t20",
"createdAt": "2022-05-19T11:38:25.059Z",
"updatedAt": "2022-05-19T11:38:25.059Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-11T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"isHomeTeam": true
},
{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": false
}
]
}
]
},
{"id": "85c530db-406e-4915-897b-24c60ae62622",
"name": "Round 3",
"abbreviatedName": "R3",
"byes": [{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179"
}
],
"isFinalRound": false,
"games": [{"id": "6837b817-7556-4911-888e-7cec2fdfba99",
"status": "PENDING",
"type": "oneDay",
"createdAt": "2022-05-19T11:38:25.066Z",
"updatedAt": "2022-05-19T11:38:25.066Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-18T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"isHomeTeam": true
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"isHomeTeam": false
}
]
}
]
},
{"id": "cb45df21-c2f9-4b2d-a448-27c600564a66",
"name": "Round 4",
"abbreviatedName": "R4",
"byes": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e"
}
],
"isFinalRound": false,
"games": [{"id": "cd1aa3cf-d2ea-47ee-a2f5-78e878f638fd",
"status": "UPCOMING",
"type": "oneDay",
"createdAt": "2022-05-19T11:38:25.078Z",
"updatedAt": "2022-05-19T11:38:25.078Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-05-25T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": true
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"isHomeTeam": false
}
]
}
]
},
{"id": "f4abcd18-fb7c-466f-ad41-297b68b96025",
"name": "Round 5",
"abbreviatedName": "R5",
"byes": [{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5"
}
],
"isFinalRound": false,
"games": [{"id": "6aa0081d-3b32-402e-b715-f250c3171b77",
"status": "UPCOMING",
"type": "oneDay",
"createdAt": "2022-05-19T11:38:25.085Z",
"updatedAt": "2022-05-19T11:38:25.085Z",
"pool": null,
"schedule": [{"day": null,
"dateTime": "2022-06-01T22:00:00.000Z",
"playingSurfaceId": "2776ade6-542e-409d-b5fc-523ca2ffeeca"
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"isHomeTeam": false
},
{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"isHomeTeam": true
}
]
}
]
},
{"id": "4bd1af9c-f49e-4888-b5ce-1bdc7573f11f",
"name": "Semi Final",
"abbreviatedName": "SF",
"byes": null,
"isFinalRound": true,
"games": [{"id": "e2ca193e-235b-43ce-a807-f1acc0f2a672",
"status": "UPCOMING",
"type": "twoDay",
"createdAt": "2022-05-19T11:38:25.507Z",
"updatedAt": "2022-05-19T11:38:25.507Z",
"pool": null,
"schedule": [ ],
"teams": [ ]
}
]
},
{"id": "801e90a1-3b19-4b90-adae-434a536afb41",
"name": "Grand Final",
"abbreviatedName": "GF",
"byes": null,
"isFinalRound": true,
"games": [{"id": "4b9689e3-dc1e-43d5-aca1-9df7e10d8d6e",
"status": "UPCOMING",
"type": "twoDay",
"createdAt": "2022-05-19T11:38:25.600Z",
"updatedAt": "2022-05-19T11:38:25.600Z",
"pool": null,
"schedule": [ ],
"teams": [ ]
}
]
}
],
"teams": [{"id": "27820591-0244-4715-85f4-9e8423c2ef1e",
"name": "C"
},
{"id": "2d66a6cd-44c7-49c0-971e-cf3321ff6179",
"name": "A"
},
{"id": "6832e28a-959e-43ac-9b07-f0178aa371c5",
"name": "B"
}
],
"playingSurfaces": [{"id": "2776ade6-542e-409d-b5fc-523ca2ffeeca",
"name": "Test ground 1",
"abbreviatedName": "TG_1",
"latitude": 23,
"longitude": 43,
"venue": {"id": "07d92eb8-28f0-4354-ba5a-7549ecb54250",
"name": "Denis's Cricket Ground",
"address": {"line1": "FERRARI ESTATE",
"126 CHARLOTTE ST": null,
"suburb": "COOKTOWN",
"postcode": 4895,
"state": "QLD",
"country": "Australia",
"longitude": 44,
"latitude": 23
},
"timezone": "Australia/Melbourne"
}
}
]
}
}

Grade Fixture Deleted Webhook

Information about a Grade Fixture Deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "GRADE_FIXTURE.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "970ca865-dbb1-4bb4-b217-8bf7288b3b30",
"eventType": "GRADE_FIXTURE.DELETED",
"entityId": "5b598b88-f1e1-44b1-a98e-0f6bba1dd1f0",
"eventRaisedDateTime": "2022-05-19T11:40:38.943Z",
"data": {"id": "5b598b88-f1e1-44b1-a98e-0f6bba1dd1f0",
"eventRaisedDateTime": "2022-05-19T11:40:38.943Z"
}
}

Games

Lists all games

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number >= 0 Default: 1 Page Number to fetch data - the maximum value of this parameter will be equal to the totalPages in response metadata
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"games": [{"id": "902c3ccd-c720-4f23-8d1f-5a37b02882c8",
"startDate": "2020-06-17T02:25:16.870000000Z",
"startTime": "10:00:00",
"matchDayNumber": {"name": "Round 1",
"sequenceNo": "1"
},
"homeTeam": {"id": "3da0d9c4-9b6e-4dcd-846f-6a2ebc4f5bbf",
"name": "U8 Boys Team D"
},
"awayTeam": {"id": "b4de8721-3c8d-4617-b2af-8e419048aa22",
"name": "U8 Boys Team A"
},
"grade": {"id": "2c412006-473b-427e-a214-be2089430616",
"name": "Monday U8 Boys"
},
"playingSurface": {"id": "f6f8f40d-4ec7-49d1-9ded-0abea2fc79fd",
"name": "Court 1",
"surfaceType": "WOODEN_NON_SPRUNG"
},
"venue": {"id": "e6e2729c-8b62-4c5c-ab97-d6fc223cb3c6",
"name": "Altona Sports Centre",
"contact": {"name": "ABC",
"phone": "12345678",
"website": "http://example.com"
},
"address": {"line1": "4/25 Arygle Street",
"suburb": "Fitzroy",
"postcode": "3206",
"state": "VIC",
"country": "Australia",
"latitude": "-36.314",
"longitude": "145.06016"
}
},
"matchDetails": {"status": "completed",
"result": "HOME_TEAM_WON",
"homeScore": 23,
"awayScore": 21
},
"createdAt": "2010-06-14T02:12:09.612Z",
"updatedAt": "2010-06-15T02:12:09.612Z"
}
]
},
"metadata": {"page": 4,
"totalPages": 36,
"totalRecords": 355
}
}

Summary for game (Private)

Game Summary detail for specified game available both pre and post game including participant line up information and statistics. Please note, this API is not applicable to Cricket. This API is organisation scoped, if you request a game that you do not have access to then you will receive a 403.

path Parameters

required

string

ID of the game

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"id": "252ad21d-e7ed-405e-98e4-a9ce0043fda5",
"status": "FINAL",
"appearances": [{"id": "da8a098e-13cd-42be-828f-1ef6db6e54ba",
"firstName": "Naomi",
"lastName": "Banks",
"roleType": "Player",
"captainRole": "CAPTAIN",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"email": "",
"gender": "F",
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 62,
"bestPlayer": 1,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 54
},
{"type": "1_POINT_SCORE",
"value": 8
}
]
},
{"id": "d76a86a2-9b37-41a8-8b53-0376d92191bf",
"firstName": "Rylee",
"lastName": "Hardin",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"email": "",
"gender": "M",
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 51,
"bestPlayer": 3,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 42
},
{"type": "1_POINT_SCORE",
"value": 9
}
]
},
{"id": "b373d150-daa3-4ba1-bb7c-dfd0f41777e5",
"firstName": "Nina",
"lastName": "Benjamin",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"email": "",
"gender": "F",
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 43,
"bestPlayer": 1,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 36
},
{"type": "1_POINT_SCORE",
"value": 7
}
]
},
{"id": "abe9f159-d970-41be-81a5-6563dd9687db",
"firstName": "Hiroko",
"lastName": "Norris",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"email": "",
"gender": "M",
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 38,
"bestPlayer": 3,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 8
},
{"type": "6_POINT_SCORE",
"value": 30
}
]
},
{"id": "428d66fb-3da0-4541-ab12-63189667dceb",
"firstName": "Rich",
"lastName": "Shelton",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"email": "",
"gender": "M",
"playerPosition": null,
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 36,
"bestPlayer": 2,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 6
},
{"type": "6_POINT_SCORE",
"value": 30
}
]
},
{"id": "3b9472ff-8838-4f58-9e2d-33987c301dc5",
"firstName": "Colby",
"lastName": "Gay",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"email": "",
"gender": "M",
"playerPosition": null,
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 30,
"bestPlayer": 2,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 6
},
{"type": "6_POINT_SCORE",
"value": 24
}
]
},
{"id": "a482ea0e-1d09-498e-a38e-a48dd857643d",
"firstName": "Tatum",
"lastName": "Wynn",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"email": "",
"gender": "M",
"playerPosition": null,
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 27,
"bestPlayer": 4,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 24
},
{"type": "1_POINT_SCORE",
"value": 3
}
]
},
{"id": "81c67b63-c88e-46e0-b75f-1b2d88e4cfbf",
"firstName": "Judah",
"lastName": "Ross",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"email": null,
"gender": "M",
"playerPosition": null,
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 2,
"bestPlayer": 4,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 2
}
]
}
],
"competitors": [{"id": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"name": "B",
"isHomeTeam": false,
"outcome": "WON",
"scoreTotal": 163,
"scoreSubTotal": [{"type": "TOTAL_BEHINDS",
"value": 25
},
{"type": "TOTAL_GOALS",
"value": 23
}
]
},
{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"name": "A",
"isHomeTeam": true,
"outcome": "LOST",
"scoreTotal": 127,
"scoreSubTotal": [{"type": "TOTAL_BEHINDS",
"value": 24
},
{"type": "TOTAL_GOALS",
"value": 17
}
]
}
],
"periods": [{"name": "FIRST_HALF",
"competitors": [{"id": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotals": 38,
"scoreSubtotals": [{"type": "1_POINT_SCORE",
"value": 20
},
{"type": "6_POINT_SCORE",
"value": 3
}
]
},
{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotals": 72,
"scoreSubtotals": [{"type": "6_POINT_SCORE",
"value": 10
},
{"type": "1_POINT_SCORE",
"value": 12
}
]
}
]
},
{"name": "SECOND_HALF",
"competitors": [{"id": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotals": 125,
"scoreSubtotals": [{"type": "6_POINT_SCORE",
"value": 20
},
{"type": "1_POINT_SCORE",
"value": 5
}
]
},
{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotals": 54,
"scoreSubtotals": [{"type": "1_POINT_SCORE",
"value": 12
},
{"type": "6_POINT_SCORE",
"value": 7
}
]
}
]
}
]
}
}

Summary for game (Public)

path Parameters

required

string

ID of the game

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `bv`, `afl`)

Responses

Response samples

Content type

application/json

{"data": {"id": "252ad21d-e7ed-405e-98e4-a9ce0043fda5",
"status": "FINAL",
"appearances": [{"id": "da8a098e-13cd-42be-828f-1ef6db6e54ba",
"firstName": "Naomi",
"lastName": "Banks",
"roleType": "Player",
"captainRole": "CAPTAIN",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 62,
"bestPlayer": 1,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 54
},
{"type": "1_POINT_SCORE",
"value": 8
}
]
},
{"id": "d76a86a2-9b37-41a8-8b53-0376d92191bf",
"firstName": "Rylee",
"lastName": "Hardin",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 51,
"bestPlayer": 3,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 42
},
{"type": "1_POINT_SCORE",
"value": 9
}
]
},
{"id": "b373d150-daa3-4ba1-bb7c-dfd0f41777e5",
"firstName": "Nina",
"lastName": "Benjamin",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 43,
"bestPlayer": 1,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 36
},
{"type": "1_POINT_SCORE",
"value": 7
}
]
},
{"id": "abe9f159-d970-41be-81a5-6563dd9687db",
"firstName": "Hiroko",
"lastName": "Norris",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 38,
"bestPlayer": 3,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 8
},
{"type": "6_POINT_SCORE",
"value": 30
}
]
},
{"id": "428d66fb-3da0-4541-ab12-63189667dceb",
"firstName": "Rich",
"lastName": "Shelton",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 36,
"bestPlayer": 2,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 6
},
{"type": "6_POINT_SCORE",
"value": 30
}
]
},
{"id": "3b9472ff-8838-4f58-9e2d-33987c301dc5",
"firstName": "Colby",
"lastName": "Gay",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 30,
"bestPlayer": 2,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 6
},
{"type": "6_POINT_SCORE",
"value": 24
}
]
},
{"id": "a482ea0e-1d09-498e-a38e-a48dd857643d",
"firstName": "Tatum",
"lastName": "Wynn",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotal": 27,
"bestPlayer": 4,
"scoreSubTotal": [{"type": "6_POINT_SCORE",
"value": 24
},
{"type": "1_POINT_SCORE",
"value": 3
}
]
},
{"id": "81c67b63-c88e-46e0-b75f-1b2d88e4cfbf",
"firstName": "Judah",
"lastName": "Ross",
"roleType": "Player",
"isFillIn": false,
"isEmergency": false,
"playerNumber": null,
"playerPosition": null,
"teamID": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotal": 2,
"bestPlayer": 4,
"scoreSubTotal": [{"type": "1_POINT_SCORE",
"value": 2
}
]
}
],
"competitors": [{"id": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"name": "B",
"isHomeTeam": false,
"outcome": "WON",
"scoreTotal": 163,
"scoreSubTotal": [{"type": "TOTAL_BEHINDS",
"value": 25
},
{"type": "TOTAL_GOALS",
"value": 23
}
]
},
{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"name": "A",
"isHomeTeam": true,
"outcome": "LOST",
"scoreTotal": 127,
"scoreSubTotal": [{"type": "TOTAL_BEHINDS",
"value": 24
},
{"type": "TOTAL_GOALS",
"value": 17
}
]
}
],
"periods": [{"name": "FIRST_HALF",
"competitors": [{"id": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotals": 38,
"scoreSubtotals": [{"type": "1_POINT_SCORE",
"value": 20
},
{"type": "6_POINT_SCORE",
"value": 3
}
]
},
{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotals": 72,
"scoreSubtotals": [{"type": "6_POINT_SCORE",
"value": 10
},
{"type": "1_POINT_SCORE",
"value": 12
}
]
}
]
},
{"name": "SECOND_HALF",
"competitors": [{"id": "39ff5553-4a8f-473e-9f0f-35396e0d8d17",
"scoreTotals": 125,
"scoreSubtotals": [{"type": "6_POINT_SCORE",
"value": 20
},
{"type": "1_POINT_SCORE",
"value": 5
}
]
},
{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"scoreTotals": 54,
"scoreSubtotals": [{"type": "1_POINT_SCORE",
"value": 12
},
{"type": "6_POINT_SCORE",
"value": 7
}
]
}
]
}
]
}
}

Summary for game V2 (Public)

Game Summary detail for specified game available both pre and post game including participant line up information and statistics, fulfilling visibility settings on PlayHQ.com. Please note, This API is not fully applicable to all territory sports, refer to v1 Public Game Summary for territory based sports such as AFL or Basketball.

path Parameters

required

string

ID of the game

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

x-api-key required	string API Key (provided by PlayHQ)
x-phq-tenant required	string PlayHQ Tenant ID (e.g. `ca`)

Responses

Response samples

Content type

application/json

{"data": {"id": "b34d56e1-f387-44b2-a73f-823c277ecc70",
"gradeId": "d09518e2-3ce5-4de4-9090-ae0ae099ece1",
"round": {"id": "89659a14-be81-4f54-959e-327cc2f32a4f",
"name": "Round 4",
"abbreviatedName": "R4",
"isFinalRound": false
},
"status": "FINAL",
"type": "t20",
"schedule": [{"day": null,
"dateTime": "2023-11-24T23:00:00.000Z",
"playingSurfaceId": "b99cbf65-417c-47c2-a4dc-a4d9836b35a3"
}
],
"appearances": [{"id": "87418681-e0cf-4018-aa2e-c13c24d35688",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"playerPosition": null
},
{"id": "5a3c3e56-a4a2-4348-b3a0-345a7f5c26b9",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"playerPosition": null
},
{"id": "bb3cdf7b-974a-4359-9471-f6b02e410bb9",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"playerPosition": null
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"playerPosition": null
},
{"id": "91642ccf-621e-47d5-a085-7ff6552281b7",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"playerPosition": null
},
{"id": "a684d712-deee-4215-8759-8f0f71c59e6f",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"playerPosition": null
},
{"id": "0a2ad1cd-ddad-47fa-904a-f388a162cc43",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"playerPosition": null
},
{"id": "989dc8ea-d88e-4c23-ace0-379e1c8c1b5f",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"playerPosition": null
},
{"id": "eef83f23-d605-4dc0-9c00-25591ccf57bd",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"playerPosition": null
},
{"id": "d30d742b-261d-467f-ae15-a17f644800a0",
"firstName": null,
"lastName": null,
"captainRole": null,
"playerNumber": null,
"isFillIn": true,
"isRegisteredPlayer": false,
"visible": false,
"roleType": "Player",
"teamId": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"playerPosition": null
}
],
"teams": [{"id": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"name": "Senior Men - Team 1",
"isHomeTeam": false,
"outcome": "LOST"
},
{"id": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"name": "Senior Men - Team 2",
"isHomeTeam": true,
"outcome": "WON"
}
],
"coinToss": {"winningTeamId": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"preference": "BAT"
},
"periods": [{"id": "edefc59b-0142-4c18-a3fc-fb8a8aa8ea78",
"name": "FIRST_INNINGS",
"sequenceNo": 1,
"teams": [{"id": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"discipline": "BOWLING",
"status": null,
"statistics": [ ],
"appearances": [{"id": "87418681-e0cf-4018-aa2e-c13c24d35688",
"displayOrder": 1,
"status": null,
"statistics": [{"type": "WICKETS",
"value": 2
},
{"type": "NO_BALLS",
"value": 1
},
{"type": "OVERS",
"value": 2.5
},
{"type": "RUNS",
"value": 9
},
{"type": "WIDES",
"value": 0
},
{"type": "ECONOMY",
"value": 3.17
},
{"type": "MAIDENS",
"value": 0
}
]
},
{"id": "a684d712-deee-4215-8759-8f0f71c59e6f",
"displayOrder": 0,
"status": null,
"statistics": [{"type": "STUMPINGS",
"value": 0
},
{"type": "TOTAL_CATCHES",
"value": 0
},
{"type": "RUN_OUTS_ASSISTED",
"value": 0
},
{"type": "TOTAL_RUN_OUTS",
"value": 1
},
{"type": "CATCHES_AS_FIELDER",
"value": 0
},
{"type": "RUN_OUTS_UNASSISTED",
"value": 1
},
{"type": "CATCHES_AS_WICKET_KEEPER",
"value": 0
}
]
}
],
"fallOfWickets": null
},
{"id": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"discipline": "BATTING",
"status": "ALL_OUT",
"statistics": [{"type": "EXTRA_WIDES",
"value": 0
},
{"type": "TOTALS",
"value": 10
},
{"type": "EXTRA_PENALTY_RUNS",
"value": 0
},
{"type": "EXTRA_BYES",
"value": 0
},
{"type": "TOTAL_EXTRAS",
"value": 1
},
{"type": "EXTRA_NO_BALLS",
"value": 1
},
{"type": "EXTRA_LEG_BYES",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 20
},
{"type": "TOTAL_SCORE",
"value": 10
},
{"type": "TOTAL_OVERS",
"value": 2.5
},
{"type": "TOTAL_OUTS",
"value": 4
}
],
"appearances": [{"id": "5a3c3e56-a4a2-4348-b3a0-345a7f5c26b9",
"displayOrder": 4,
"status": "OUT",
"statistics": [{"type": "SIXES",
"value": 0
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 300
},
{"type": "FOURS",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 3
}
]
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "TOTAL_RUNS",
"value": 2
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "FOURS",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 100
},
{"type": "SIXES",
"value": 0
}
]
},
{"id": "989dc8ea-d88e-4c23-ace0-379e1c8c1b5f",
"displayOrder": 1,
"status": "OUT",
"statistics": [{"type": "STRIKE_RATE",
"value": 30
},
{"type": "SIXES",
"value": 0
},
{"type": "FOURS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 10
},
{"type": "TOTAL_RUNS",
"value": 3
}
]
},
{"id": "eef83f23-d605-4dc0-9c00-25591ccf57bd",
"displayOrder": 5,
"status": "NOT_OUT",
"statistics": [{"type": "STRIKE_RATE",
"value": 0
},
{"type": "FOURS",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 0
},
{"type": "SIXES",
"value": 0
},
{"type": "BALLS_FACED",
"value": 0
}
]
},
{"id": "d30d742b-261d-467f-ae15-a17f644800a0",
"displayOrder": 3,
"status": "OUT",
"statistics": [{"type": "SIXES",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 25
},
{"type": "FOURS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 4
}
]
}
],
"fallOfWickets": [{"sequenceNo": 1,
"appearanceId": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"runs": 2
},
{"sequenceNo": 2,
"appearanceId": "d30d742b-261d-467f-ae15-a17f644800a0",
"runs": 4
},
{"sequenceNo": 3,
"appearanceId": "5a3c3e56-a4a2-4348-b3a0-345a7f5c26b9",
"runs": 9
},
{"sequenceNo": 4,
"appearanceId": "989dc8ea-d88e-4c23-ace0-379e1c8c1b5f",
"runs": 9
}
]
}
],
"sharedStatistics": [{"type": "RUN_OUT",
"appearances": [{"id": "a684d712-deee-4215-8759-8f0f71c59e6f",
"role": "FIELDING"
},
{"id": "989dc8ea-d88e-4c23-ace0-379e1c8c1b5f",
"role": "BATTING"
}
]
},
{"type": "CAUGHT",
"appearances": [{"id": "87418681-e0cf-4018-aa2e-c13c24d35688",
"role": "BOWLING"
},
{"id": "d30d742b-261d-467f-ae15-a17f644800a0",
"role": "BATTING"
},
{"id": "a684d712-deee-4215-8759-8f0f71c59e6f",
"role": "FIELDING"
}
]
},
{"type": "HIT_BALL_TWICE",
"appearances": [{"id": "5a3c3e56-a4a2-4348-b3a0-345a7f5c26b9",
"role": "BATTING"
}
]
},
{"type": "BOWLED",
"appearances": [{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "BATTING"
},
{"id": "87418681-e0cf-4018-aa2e-c13c24d35688",
"role": "BOWLING"
}
]
}
]
},
{"id": "b9be2e31-1d30-4088-9f04-283a9a421f34",
"name": "FIRST_INNINGS",
"sequenceNo": 2,
"teams": [{"id": "68fc386a-24e2-4216-abe7-ea030abcbee4",
"discipline": "BATTING",
"status": "ALL_OUT",
"statistics": [{"type": "TOTAL_EXTRAS",
"value": 2
},
{"type": "TOTALS",
"value": 6
},
{"type": "EXTRA_WIDES",
"value": 2
},
{"type": "EXTRA_BYES",
"value": 0
},
{"type": "EXTRA_PENALTY_RUNS",
"value": 0
},
{"type": "EXTRA_NO_BALLS",
"value": 0
},
{"type": "EXTRA_LEG_BYES",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 20
},
{"type": "TOTAL_SCORE",
"value": 6
},
{"type": "TOTAL_OVERS",
"value": 1.5
},
{"type": "TOTAL_OUTS",
"value": 4
}
],
"appearances": [{"id": "87418681-e0cf-4018-aa2e-c13c24d35688",
"displayOrder": 1,
"status": "OUT",
"statistics": [{"type": "SIXES",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 2
},
{"type": "BALLS_FACED",
"value": 5
},
{"type": "STRIKE_RATE",
"value": 40
},
{"type": "FOURS",
"value": 0
}
]
},
{"id": "bb3cdf7b-974a-4359-9471-f6b02e410bb9",
"displayOrder": 5,
"status": "OUT",
"statistics": [{"type": "TOTAL_RUNS",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 0
},
{"type": "FOURS",
"value": 0
},
{"type": "SIXES",
"value": 0
},
{"type": "BALLS_FACED",
"value": 0
}
]
},
{"id": "91642ccf-621e-47d5-a085-7ff6552281b7",
"displayOrder": 4,
"status": "OUT",
"statistics": [{"type": "SIXES",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 0
},
{"type": "BALLS_FACED",
"value": 0
},
{"type": "FOURS",
"value": 0
}
]
},
{"id": "a684d712-deee-4215-8759-8f0f71c59e6f",
"displayOrder": 3,
"status": "NOT_OUT",
"statistics": [{"type": "BALLS_FACED",
"value": 1
},
{"type": "SIXES",
"value": 0
},
{"type": "FOURS",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 100
},
{"type": "TOTAL_RUNS",
"value": 1
}
]
},
{"id": "0a2ad1cd-ddad-47fa-904a-f388a162cc43",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "SIXES",
"value": 0
},
{"type": "BALLS_FACED",
"value": 3
},
{"type": "TOTAL_RUNS",
"value": 1
},
{"type": "FOURS",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 33.33
}
]
}
],
"fallOfWickets": [{"sequenceNo": 1,
"appearanceId": "87418681-e0cf-4018-aa2e-c13c24d35688",
"runs": 3
},
{"sequenceNo": 2,
"appearanceId": "0a2ad1cd-ddad-47fa-904a-f388a162cc43",
"runs": 4
},
{"sequenceNo": 3,
"appearanceId": "91642ccf-621e-47d5-a085-7ff6552281b7",
"runs": 5
},
{"sequenceNo": 4,
"appearanceId": "bb3cdf7b-974a-4359-9471-f6b02e410bb9",
"runs": 6
}
]
},
{"id": "b06ef5ff-10d4-44bd-b744-32ea3ab74924",
"discipline": "BOWLING",
"status": null,
"statistics": [ ],
"appearances": [{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"displayOrder": 1,
"status": null,
"statistics": [{"type": "CATCHES_AS_WICKET_KEEPER",
"value": 0
},
{"type": "OVERS",
"value": 1.5
},
{"type": "TOTAL_CATCHES",
"value": 0
},
{"type": "WICKETS",
"value": 4
},
{"type": "NO_BALLS",
"value": 0
},
{"type": "CATCHES_AS_FIELDER",
"value": 0
},
{"type": "MAIDENS",
"value": 0
},
{"type": "TOTAL_RUN_OUTS",
"value": 0
},
{"type": "RUN_OUTS_UNASSISTED",
"value": 0
},
{"type": "STUMPINGS",
"value": 1
},
{"type": "RUNS",
"value": 6
},
{"type": "RUN_OUTS_ASSISTED",
"value": 0
},
{"type": "ECONOMY",
"value": 3.27
},
{"type": "WIDES",
"value": 2
}
]
}
],
"fallOfWickets": null
}
],
"sharedStatistics": [{"type": "STUMPED",
"appearances": [{"id": "91642ccf-621e-47d5-a085-7ff6552281b7",
"role": "BATTING"
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "FIELDING"
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "BOWLING"
}
]
},
{"type": "LEG_BEFORE_WICKET",
"appearances": [{"id": "0a2ad1cd-ddad-47fa-904a-f388a162cc43",
"role": "BATTING"
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "BOWLING"
}
]
},
{"type": "CAUGHT",
"appearances": [{"id": "87418681-e0cf-4018-aa2e-c13c24d35688",
"role": "BATTING"
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "BOWLING"
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "FIELDING"
}
]
},
{"type": "HIT_WICKET",
"appearances": [{"id": "bb3cdf7b-974a-4359-9471-f6b02e410bb9",
"role": "BATTING"
},
{"id": "edbd7ada-b549-41b8-bb9a-7a4bfcda404b",
"role": "BOWLING"
}
]
}
]
}
],
"playingSurfaces": [{"id": "b99cbf65-417c-47c2-a4dc-a4d9836b35a3",
"name": "Oval 1",
"abbreviatedName": "O1",
"longitude": null,
"latitude": null,
"venue": {"id": "0fa66043-a235-4403-9a86-763201173d98",
"name": "Test Venue",
"timezone": "Australia/Melbourne"
}
}
]
}
}

Game Events (Private)

The Game Events API provides game events captured during a game scored on PlayHQ’s Electronic Scoring Platform. Please note, this API is not applicable to Cricket at present.

path Parameters

id	string ID of the game

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

200
4XX, 5XX

Content type

application/json

{"data": {"id": "24b76cc2-3b52-4372-9046-1e7182364169",
"events": [{"id": "acdd62fb-a811-49fb-8325-b93190c3d6b9",
"type": "SCORE",
"timestamp": "2022-08-04T03:23:34.797Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 7
},
{"type": "SECONDS",
"value": 56
}
],
"appearances": [{"id": "b373d150-daa3-4ba1-bb7c-dfd0f41777e5",
"role": null,
"statistics": [{"type": "6_POINT_SCORE",
"value": 6
}
]
}
],
"teams": [ ]
},
{"id": "d969d627-94df-4dd1-8b54-a2057bcc9a2b",
"type": "SCORE",
"timestamp": "2022-08-04T03:23:37.084Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 7
},
{"type": "SECONDS",
"value": 54
}
],
"appearances": [{"id": "abe9f159-d970-41be-81a5-6563dd9687db",
"role": null,
"statistics": [{"type": "1_POINT_SCORE",
"value": 1
}
]
}
],
"teams": [ ]
},
{"id": "854c1ee0-b0b4-4868-8e1c-65852c185564",
"type": "SCORE",
"timestamp": "2022-08-04T03:23:39.865Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 7
},
{"type": "SECONDS",
"value": 51
}
],
"appearances": [{"id": "428d66fb-3da0-4541-ab12-63189667dceb",
"role": null,
"statistics": [{"type": "1_POINT_SCORE",
"value": 1
}
]
}
],
"teams": [ ]
},
{"id": "854a47ec-a992-4e90-bfe6-6e50001ca1b4",
"type": "CARD",
"timestamp": "2022-08-04T03:23:50.369Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 7
},
{"type": "SECONDS",
"value": 40
}
],
"appearances": [ ],
"teams": [{"id": "1259bcb8-e4c1-46bb-b3bc-f21764184318",
"statistics": [{"type": "YELLOW_CARD",
"value": 1
}
]
}
]
},
{"id": "4100cdc8-f1a2-4b01-b6e0-971f8b471b38",
"type": "SCORE",
"timestamp": "2022-08-04T03:23:57.455Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 7
},
{"type": "SECONDS",
"value": 33
}
],
"appearances": [{"id": "a482ea0e-1d09-498e-a38e-a48dd857643d",
"role": null,
"statistics": [{"type": "6_POINT_SCORE",
"value": 6
}
]
}
],
"teams": [ ]
},
{"id": "4e44cc8e-b596-4a4a-9f96-47708b79e5ce",
"type": "CARD",
"timestamp": "2022-08-04T03:24:32.218Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 6
},
{"type": "SECONDS",
"value": 58
}
],
"appearances": [{"id": "81c67b63-c88e-46e0-b75f-1b2d88e4cfbf",
"role": null,
"statistics": [{"type": "RED_CARD",
"value": 1
}
]
}
],
"teams": [ ]
},
{"id": "4fe96a88-44ff-4c7c-ad4f-8b1e1a205834",
"type": "SCORE",
"timestamp": "2022-08-04T03:24:36.061Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 6
},
{"type": "SECONDS",
"value": 55
}
],
"appearances": [{"id": "d76a86a2-9b37-41a8-8b53-0376d92191bf",
"role": null,
"statistics": [{"type": "6_POINT_SCORE",
"value": 6
}
]
}
],
"teams": [ ]
},
{"id": "575b6eff-2a65-4df5-b7eb-02cd40fe1f47",
"type": "SCORE",
"timestamp": "2022-08-04T03:24:40.400Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 6
},
{"type": "SECONDS",
"value": 50
}
],
"appearances": [{"id": "3b9472ff-8838-4f58-9e2d-33987c301dc5",
"role": null,
"statistics": [{"type": "1_POINT_SCORE",
"value": 1
}
]
}
],
"teams": [ ]
},
{"id": "7e801db2-c1aa-4df5-9641-3ac27e8a8d04",
"type": "SCORE",
"timestamp": "2022-08-04T03:25:02.819Z",
"gameTime": [{"type": "PERIOD",
"value": "FIRST_QTR"
},
{"type": "MINUTES",
"value": 6
},
{"type": "SECONDS",
"value": 28
}
],
"appearances": [{"id": "da8a098e-13cd-42be-828f-1ef6db6e54ba",
"role": null,
"statistics": [{"type": "6_POINT_SCORE",
"value": 6
}
]
}
],
"teams": [ ]
}
]
}
}

Live-streaming Enabled (Private)

Update live-streaming enabled for specified game. Please note, this API is applicable to Cricket.

path Parameters

required

string

ID of the game

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Request Body schema: application/json

liveStreamingEnabled

boolean

Boolean value to indicate if the game is enabled for livestreaming

Responses

Request samples

Payload

Content type

application/json

{"liveStreamingEnabled": true
}

Response samples

Content type

application/json

{"data": {"success": true
}
}

Games for organisation

Games fixture and associated game information under a specified organisation on a given day.

path Parameters

id required	string ID of the organisation
date required	string Date of the game

query Parameters

cursor

string

Optional. If a response has metadata.hasMore == true, set this parameter to metadata.nextCursor to request the next page of results.

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": [{"id": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"status": "UPCOMING",
"createdAt": "2015-08-05T08:40:51.620Z",
"updatedAt": "2015-08-05T08:40:51.620Z",
"association": {"id": "ccc647fa-286a-433b-8284-464c37d6f049",
"name": "Keilor Basketball Association",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-basketball-association/ccc647fa",
"logo": {"sizes": [{"url": "https://assets.playhq.com/bv/ccc647/64_64_logo.png",
"dimensions": {"width": 64,
"height": 64
}
}
]
}
},
"competition": {"id": "8e4e71fc-1f3e-4eba-9701-d5f361d2c269",
"name": "Victorian Junior Basketball League"
},
"season": {"id": "11ed119a-cb8f-4faa-a338-cb714ba97a8c",
"name": 2021,
"status": "ACTIVE",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-basketball-association/junior-domestic-winter-2021/8e4e71fc"
},
"grade": {"id": "d1f9c41d-cb8f-4faa-a338-cb714ba97a8c",
"name": "12 Boys - VJL2 (P2)",
"url": "https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768"
},
"round": {"id": "a93c2389-b361-4af1-95f1-a758900fb018",
"name": "Round 1"
},
"pool": {"id": "d2fb442d-cebb-4fe3-ac2d-33e1a5f1055d",
"name": "Pool A"
},
"schedule": {"date": "2015-08-05T00:00:00.000Z",
"time": "08:40:51",
"timezone": "Australia/Melbourne"
},
"competitors": [{"id": "95c446ef-dea5-486e-96bb-1bb24a609177",
"name": "Keilor U12 Boys 2",
"isHomeTeam": true,
"outcome": "WON",
"scoreTotal": 45,
"scoreSubTotal": [{"type": "GOALS_TOTAL",
"count": 2,
"value": 12
},
{"type": "BEHINDS_TOTAL",
"count": 2,
"value": 2
}
]
},
{"id": "0ed2c665-1a3e-4cd6-8448-22bef74e54b6",
"name": "Diamond Valley U12 Boys 2",
"isHomeTeam": false,
"outcome": "LOST",
"scoreTotal": 39,
"scoreSubTotal": [{"type": "GOALS_TOTAL",
"count": 2,
"value": 12
},
{"type": "BEHINDS_TOTAL",
"count": 2,
"value": 2
}
]
}
],
"venue": {"id": "eccf8810-7d57-4ffd-bb48-9418e3eb93ac",
"name": "Keilor Basketball Netball Stadium",
"surfaceName": "Court 1",
"surfaceAbbreviation": "CRT1",
"address": {"line1": "Stadium Dr",
"suburb": "Keilor Park",
"postcode": 3042,
"state": "VIC",
"country": "AU",
"latitude": -37.713286,
"longitude": 144.848203
}
}
}
],
"metadata": {"hasMore": true,
"nextCursor": "dXNlcjpXMDdRQ1JQQTQ="
}
}

Game Updated Webhook

Game Summary webhook capturing real time updates pre and post game including participant & team line up information, statistics and schedule.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "GAME.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

Example

{"messageId": "cf3c1bf7-1e2f-49d7-9e8a-dd252f773498",
"eventType": "GAME.UPDATED",
"entityId": "559afa9c-3f5e-4212-a26f-5bf8567b1778",
"eventRaisedDateTime": "2023-10-22T23:38:44.673Z",
"data": {"id": "559afa9c-3f5e-4212-a26f-5bf8567b1778",
"gradeId": "e0be1548-db39-40c5-96f4-ed65bcf6921c",
"status": "FINAL",
"type": "t20",
"round": {"id": "ec9795d9-79a5-4329-8e04-674fdbb04174",
"name": "Round 20",
"abbreviatedName": "R20",
"isFinalRound": false
},
"schedule": [{"dateTime": "2023-10-17T23:00:00.000Z",
"playingSurfaceId": "83b417d7-4b24-4599-806c-a9457752101a"
}
],
"appearances": [{"id": "71e465f5-665e-495e-96e2-c1fa21d96d6f",
"firstName": "Mary",
"lastName": "Rosales",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "9b9a2a16-5049-49df-a402-50e8feac6b77",
"firstName": "Fuller",
"lastName": "Barrera",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "a269aa6d-330d-4da3-a7c3-07c6d1ef64cb",
"firstName": "Kaitlin",
"lastName": "Clarke",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "0379093d-b955-4a3b-a1f9-81592134f8de",
"firstName": "Kirk",
"lastName": "Duffy",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "b9173601-4533-4f80-a367-91cdbefd998e",
"firstName": "Hanae",
"lastName": "Whitehead",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "1e4336ca-c5d3-4330-acdb-344e7e82cffb",
"firstName": "Adara",
"lastName": "Ferrell",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"firstName": "Cassady",
"lastName": "Barr",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "1aa2a005-09f2-49b6-bca1-a27b434cdccd",
"firstName": "Illana",
"lastName": "Carpenter",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "c061aadf-577b-4499-a3d6-2621dc7f3038",
"firstName": "Nelle",
"lastName": "Rowland",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "2bc7f21d-7dc7-4dcd-a992-f0086b638dbf",
"firstName": "Mira",
"lastName": "Clements",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "99100156-7e3d-4ab5-818a-369dbc90875d",
"firstName": "Ila",
"lastName": "Mccullough",
"roleType": "Player",
"captainRole": null,
"isFillIn": true,
"visible": false,
"teamId": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"isRegisteredPlayer": false,
"playerPosition": null
},
{"id": "cdc9aaa8-ee73-4c1e-bb02-624b2419ac62",
"firstName": "Dar`th Dar’th Dar'th Dar\"th",
"lastName": "Vader",
"roleType": "Player",
"captainRole": null,
"isFillIn": false,
"visible": true,
"teamId": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"isRegisteredPlayer": true,
"playerPosition": null
},
{"id": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"firstName": "John",
"lastName": "Smith",
"roleType": "Player",
"captainRole": null,
"isFillIn": false,
"visible": true,
"teamId": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"isRegisteredPlayer": true,
"playerPosition": null
},
{"id": "49cff0f1-e443-46bf-b6fc-cf4995648acb",
"firstName": "Amélie Jérôme",
"lastName": "Nguyễn Schütte",
"roleType": "Player",
"captainRole": null,
"isFillIn": false,
"visible": true,
"teamId": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"isRegisteredPlayer": true,
"playerPosition": null
},
{"id": "a4133ab3-65a7-4252-8090-822b82655d36",
"firstName": "Cameron",
"lastName": "Smith",
"roleType": "Player",
"captainRole": null,
"isFillIn": false,
"visible": true,
"teamId": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"isRegisteredPlayer": true,
"playerPosition": null
},
{"id": "90498f88-b1d3-4607-819a-fcea202b0716",
"firstName": "Tim",
"lastName": "Smith",
"roleType": "Player",
"captainRole": null,
"isFillIn": false,
"visible": true,
"teamId": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"isRegisteredPlayer": true,
"playerPosition": null
}
],
"teams": [{"id": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"name": "Friday Senior Men - Team 1",
"isHomeTeam": true,
"outcome": "LOST"
},
{"id": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"name": "Friday Senior Men - Team 2",
"isHomeTeam": false,
"outcome": "WON"
}
],
"coinToss": {"winningTeamId": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"preference": "BAT"
},
"periods": [{"id": "9ee8b309-ec37-4347-96aa-ce15f9bf5adb",
"name": "FIRST_INNINGS",
"sequenceNo": 1,
"teams": [{"id": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"status": "ALL_OUT",
"discipline": "BATTING",
"statistics": [{"type": "TOTAL_EXTRAS",
"value": 1
},
{"type": "TOTALS",
"value": 31
},
{"type": "EXTRA_LEG_BYES",
"value": 0
},
{"type": "EXTRA_BYES",
"value": 0
},
{"type": "EXTRA_NO_BALLS",
"value": 1
},
{"type": "EXTRA_WIDES",
"value": 0
},
{"type": "EXTRA_PENALTY_RUNS",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 3
},
{"type": "TOTAL_OUTS",
"value": 4
},
{"type": "TOTAL_SCORE",
"value": 31
},
{"type": "OVER_LIMIT",
"value": 20
}
],
"appearances": [{"id": "cdc9aaa8-ee73-4c1e-bb02-624b2419ac62",
"displayOrder": 3,
"status": "OUT",
"statistics": [{"type": "FOURS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "STRIKE_RATE",
"value": 50
},
{"type": "TOTAL_RUNS",
"value": 1
},
{"type": "SIXES",
"value": 0
}
]
},
{"id": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "FOURS",
"value": 1
},
{"type": "SIXES",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 225
},
{"type": "BALLS_FACED",
"value": 4
},
{"type": "TOTAL_RUNS",
"value": 9
}
]
},
{"id": "49cff0f1-e443-46bf-b6fc-cf4995648acb",
"displayOrder": 1,
"status": "OUT",
"statistics": [{"type": "BALLS_FACED",
"value": 1
},
{"type": "SIXES",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 0
},
{"type": "FOURS",
"value": 0
}
]
},
{"id": "a4133ab3-65a7-4252-8090-822b82655d36",
"displayOrder": 4,
"status": "OUT",
"statistics": [{"type": "STRIKE_RATE",
"value": 200
},
{"type": "BALLS_FACED",
"value": 6
},
{"type": "SIXES",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 12
},
{"type": "FOURS",
"value": 1
}
]
},
{"id": "90498f88-b1d3-4607-819a-fcea202b0716",
"displayOrder": 5,
"status": "NOT_OUT",
"statistics": [{"type": "TOTAL_RUNS",
"value": 8
},
{"type": "BALLS_FACED",
"value": 4
},
{"type": "FOURS",
"value": 0
},
{"type": "SIXES",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 200
}
]
}
],
"fallOfWickets": [{"sequenceNo": 1,
"appearanceId": "49cff0f1-e443-46bf-b6fc-cf4995648acb",
"runs": 0
},
{"sequenceNo": 2,
"appearanceId": "cdc9aaa8-ee73-4c1e-bb02-624b2419ac62",
"runs": 6
},
{"sequenceNo": 3,
"appearanceId": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"runs": 17
},
{"sequenceNo": 4,
"appearanceId": "a4133ab3-65a7-4252-8090-822b82655d36",
"runs": 31
}
]
},
{"id": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"discipline": "BOWLING",
"statistics": [ ],
"appearances": [{"id": "9b9a2a16-5049-49df-a402-50e8feac6b77",
"displayOrder": 2,
"status": null,
"statistics": [{"type": "NO_BALLS",
"value": 1
},
{"type": "WIDES",
"value": 0
},
{"type": "OVERS",
"value": 1
},
{"type": "ECONOMY",
"value": 13
},
{"type": "WICKETS",
"value": 0
},
{"type": "MAIDENS",
"value": 0
},
{"type": "RUNS",
"value": 13
}
]
},
{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"displayOrder": 1,
"status": null,
"statistics": [{"type": "CATCHES_AS_WICKET_KEEPER",
"value": 1
},
{"type": "TOTAL_CATCHES",
"value": 1
},
{"type": "RUN_OUTS_UNASSISTED",
"value": 0
},
{"type": "WIDES",
"value": 1
},
{"type": "TOTAL_RUN_OUTS",
"value": 0
},
{"type": "OVERS",
"value": 2
},
{"type": "RUN_OUTS_ASSISTED",
"value": 0
},
{"type": "NO_BALLS",
"value": 0
},
{"type": "WICKETS",
"value": 3
},
{"type": "ECONOMY",
"value": 9
},
{"type": "RUNS",
"value": 18
},
{"type": "MAIDENS",
"value": 0
},
{"type": "CATCHES_AS_FIELDER",
"value": 0
},
{"type": "STUMPINGS",
"value": 0
}
]
}
],
"fallOfWickets": null
}
],
"sharedStatistics": [{"appearances": [{"id": "a4133ab3-65a7-4252-8090-822b82655d36",
"role": "BATTING"
},
{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"role": "BOWLING"
}
],
"type": "LEG_BEFORE_WICKET"
},
{"appearances": [{"id": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"role": "BATTING"
}
],
"type": "HIT_BALL_TWICE"
},
{"appearances": [{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"role": "BOWLING"
},
{"id": "49cff0f1-e443-46bf-b6fc-cf4995648acb",
"role": "BATTING"
}
],
"type": "BOWLED"
},
{"appearances": [{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"role": "BOWLING"
},
{"id": "cdc9aaa8-ee73-4c1e-bb02-624b2419ac62",
"role": "BATTING"
},
{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"role": "FIELDING"
}
],
"type": "CAUGHT"
}
]
},
{"id": "ee8b5af0-ba64-4274-9d5e-57aef1357efc",
"name": "FIRST_INNINGS",
"sequenceNo": 2,
"teams": [{"id": "53c5b215-7eca-47ea-b9ec-cbd16a8646ac",
"discipline": "BOWLING",
"statistics": [ ],
"appearances": [{"id": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"displayOrder": 1,
"status": null,
"statistics": [{"type": "RUN_OUTS_UNASSISTED",
"value": 1
},
{"type": "ECONOMY",
"value": 9.5
},
{"type": "MAIDENS",
"value": 0
},
{"type": "TOTAL_CATCHES",
"value": 0
},
{"type": "CATCHES_AS_WICKET_KEEPER",
"value": 0
},
{"type": "OVERS",
"value": 2
},
{"type": "RUN_OUTS_ASSISTED",
"value": 0
},
{"type": "STUMPINGS",
"value": 0
},
{"type": "RUNS",
"value": 19
},
{"type": "WICKETS",
"value": 1
},
{"type": "TOTAL_RUN_OUTS",
"value": 1
},
{"type": "CATCHES_AS_FIELDER",
"value": 0
},
{"type": "NO_BALLS",
"value": 1
},
{"type": "WIDES",
"value": 1
}
]
},
{"id": "a4133ab3-65a7-4252-8090-822b82655d36",
"displayOrder": 2,
"status": null,
"statistics": [{"type": "WICKETS",
"value": 1
},
{"type": "ECONOMY",
"value": 13
},
{"type": "RUNS",
"value": 13
},
{"type": "MAIDENS",
"value": 0
},
{"type": "WIDES",
"value": 0
},
{"type": "NO_BALLS",
"value": 0
},
{"type": "OVERS",
"value": 1
}
]
}
],
"fallOfWickets": null
},
{"id": "4f305594-8ae2-465f-b7ec-a4c1c7930fe2",
"discipline": "BATTING",
"statistics": [{"type": "EXTRA_PENALTY_RUNS",
"value": 0
},
{"type": "EXTRA_NO_BALLS",
"value": 1
},
{"type": "TOTAL_EXTRAS",
"value": 3
},
{"type": "EXTRA_WIDES",
"value": 1
},
{"type": "EXTRA_LEG_BYES",
"value": 1
},
{"type": "TOTALS",
"value": 33
},
{"type": "EXTRA_BYES",
"value": 0
},
{"type": "TOTAL_OUTS",
"value": 6
},
{"type": "TOTAL_OVERS",
"value": 3
},
{"type": "TOTAL_SCORE",
"value": 33
},
{"type": "OVER_LIMIT",
"value": 20
}
],
"appearances": [{"id": "71e465f5-665e-495e-96e2-c1fa21d96d6f",
"displayOrder": 9,
"status": "DID_NOT_BAT",
"statistics": [ ]
},
{"id": "9b9a2a16-5049-49df-a402-50e8feac6b77",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "SIXES",
"value": 0
},
{"type": "FOURS",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 50
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 1
}
]
},
{"id": "a269aa6d-330d-4da3-a7c3-07c6d1ef64cb",
"displayOrder": 4,
"status": "OUT",
"statistics": [{"type": "BALLS_FACED",
"value": 1
},
{"type": "TOTAL_RUNS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 100
},
{"type": "SIXES",
"value": 0
},
{"type": "FOURS",
"value": 0
}
]
},
{"id": "0379093d-b955-4a3b-a1f9-81592134f8de",
"displayOrder": 6,
"status": "OUT",
"statistics": [{"type": "BALLS_FACED",
"value": 2
},
{"type": "FOURS",
"value": 1
},
{"type": "TOTAL_RUNS",
"value": 7
},
{"type": "SIXES",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 350
}
]
},
{"id": "b9173601-4533-4f80-a367-91cdbefd998e",
"displayOrder": 11,
"status": "DID_NOT_BAT",
"statistics": [ ]
},
{"id": "1e4336ca-c5d3-4330-acdb-344e7e82cffb",
"displayOrder": 8,
"status": "NOT_OUT",
"statistics": [{"type": "BALLS_FACED",
"value": 1
},
{"type": "TOTAL_RUNS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 100
},
{"type": "SIXES",
"value": 0
},
{"type": "FOURS",
"value": 0
}
]
},
{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"displayOrder": 1,
"status": "OUT",
"statistics": [{"type": "FOURS",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 3
},
{"type": "SIXES",
"value": 0
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 300
}
]
},
{"id": "1aa2a005-09f2-49b6-bca1-a27b434cdccd",
"displayOrder": 3,
"status": "OUT",
"statistics": [{"type": "TOTAL_RUNS",
"value": 14
},
{"type": "FOURS",
"value": 0
},
{"type": "SIXES",
"value": 0
},
{"type": "STRIKE_RATE",
"value": 200
},
{"type": "BALLS_FACED",
"value": 7
}
]
},
{"id": "c061aadf-577b-4499-a3d6-2621dc7f3038",
"displayOrder": 10,
"status": "DID_NOT_BAT",
"statistics": [ ]
},
{"id": "2bc7f21d-7dc7-4dcd-a992-f0086b638dbf",
"displayOrder": 5,
"status": "OUT",
"statistics": [{"type": "STRIKE_RATE",
"value": 0
},
{"type": "FOURS",
"value": 0
},
{"type": "TOTAL_RUNS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "SIXES",
"value": 0
}
]
},
{"id": "99100156-7e3d-4ab5-818a-369dbc90875d",
"displayOrder": 7,
"status": "NOT_OUT",
"statistics": [{"type": "STRIKE_RATE",
"value": 150
},
{"type": "FOURS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 3
},
{"type": "SIXES",
"value": 0
}
]
}
],
"fallOfWickets": [{"sequenceNo": 1,
"appearanceId": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"runs": 4
},
{"sequenceNo": 2,
"appearanceId": "9b9a2a16-5049-49df-a402-50e8feac6b77",
"runs": 11
},
{"sequenceNo": 3,
"appearanceId": "a269aa6d-330d-4da3-a7c3-07c6d1ef64cb",
"runs": 19
},
{"sequenceNo": 4,
"appearanceId": "2bc7f21d-7dc7-4dcd-a992-f0086b638dbf",
"runs": 19
},
{"sequenceNo": 5,
"appearanceId": "0379093d-b955-4a3b-a1f9-81592134f8de",
"runs": 27
},
{"sequenceNo": 6,
"appearanceId": "1aa2a005-09f2-49b6-bca1-a27b434cdccd",
"runs": 35
}
]
}
],
"sharedStatistics": [{"appearances": [{"id": "a269aa6d-330d-4da3-a7c3-07c6d1ef64cb",
"role": "BATTING"
}
],
"type": "TIMED_OUT"
},
{"appearances": [{"id": "9b9a2a16-5049-49df-a402-50e8feac6b77",
"role": "BATTING"
}
],
"type": "OBSTRUCTING_FIELD"
},
{"appearances": [{"id": "2bc7f21d-7dc7-4dcd-a992-f0086b638dbf",
"role": "BATTING"
},
{"id": "a4133ab3-65a7-4252-8090-822b82655d36",
"role": "BOWLING"
}
],
"type": "BOWLED"
},
{"appearances": [{"id": "b6be4756-7db3-49f0-bdb8-85ab0c0a2062",
"role": "BATTING"
}
],
"type": "HIT_BALL_TWICE"
},
{"appearances": [{"id": "1aa2a005-09f2-49b6-bca1-a27b434cdccd",
"role": "BATTING"
},
{"id": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"role": "FIELDING"
}
],
"type": "RUN_OUT"
},
{"appearances": [{"id": "0379093d-b955-4a3b-a1f9-81592134f8de",
"role": "BATTING"
},
{"id": "edcfd224-fba6-4cb7-a8df-cf5aea864bf5",
"role": "BOWLING"
}
],
"type": "HIT_WICKET"
}
]
}
],
"playingSurfaces": [{"id": "83b417d7-4b24-4599-806c-a9457752101a",
"name": "Oval 3",
"abbreviatedName": "O3",
"venue": {"id": "08ef95a4-c37d-443d-a303-23f88854c0e9",
"name": "JFK Oval",
"timezone": "Australia/Melbourne"
},
"longitude": "",
"latitude": ""
}
]
}
}

Game Deleted Webhook

Game Summary webhook capturing real time updates pre and post game including participant & team line up information, statistics and schedule. This webhook is only applicable to Cricket at present.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "GAME.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"entityId": "a77bee3c-30f2-11ec-8d3d-0242ac130003",
"eventRaisedDateTime": "2022-04-06T09:23:23.054Z",
"eventType": "GAME.DELETED",
"data": {"id": "650d959f-0a11-44bd-8e0a-339f6ed91288",
"eventRaisedDateTime": "2022-04-06T09:23:23.054Z"
}
}

Live Game Scorecard Updated Webhook

Live Game Scorecard webhook captures the full scorecard for a game, triggered at various intervals during a live scored game.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "LIVE_GAME.SCORECARD_UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

Example

{"messageId": "16f8b088-4269-480a-bbaf-94d84b075bd1",
"eventType": "LIVE_GAME.SCORECARD_UPDATED",
"entityId": "7fc2a5be-6590-4c0c-9336-d59b53d33c08",
"eventRaisedDateTime": "2023-07-31T02:20:04.416Z",
"data": {"id": "90ff3919-1153-4e42-9df2-12f2d5b92292",
"eventId": "7fc2a5be-6590-4c0c-9336-d59b53d33c08",
"periods": [{"id": "26d78249-aa30-4165-8bcb-484e566d0a24",
"name": "FIRST_INNINGS",
"status": "ENDED",
"sequenceNo": 1,
"teams": [{"id": "c980b7df-7e1a-40da-a4f8-67c8128c57b0",
"discipline": "BATTING",
"status": "ALL_OUT",
"statistics": [{"type": "TOTAL_OUTS",
"value": 4
},
{"type": "TOTAL_SCORE",
"value": 18
},
{"type": "TOTAL_OVERS",
"value": 1.1
},
{"type": "OVER_LIMIT",
"value": 40
},
{"type": "EXTRA_NO_BALLS",
"value": 1
},
{"type": "TOTAL_EXTRAS",
"value": 1
}
],
"appearances": [{"id": "a86c8c04-43b8-4021-8b16-a3400cd0d328",
"displayOrder": 1,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 2
},
{"type": "CURRENT_RUNS",
"value": 1
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 50
}
]
},
{"id": "eddaab8b-30a1-48a6-b91a-104568b07d4b",
"displayOrder": 3,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 1
},
{"type": "CURRENT_RUNS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 0
}
]
},
{"id": "3edc3d3d-37a6-457a-a342-3fa28e01b8dd",
"displayOrder": 4,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 2
},
{"type": "CURRENT_RUNS",
"value": 10
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 10
},
{"type": "FOURS",
"value": 1
},
{"type": "SIXES",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 500
}
]
},
{"id": "7f5d65b4-6dc5-4ac6-8f84-0734605162fc",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 2
},
{"type": "CURRENT_RUNS",
"value": 6
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 6
},
{"type": "SIXES",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 300
}
]
},
{"id": "a3db9276-5d72-4fed-849f-53c6d8c097da",
"displayOrder": 5,
"status": "NOT_OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 0
},
{"type": "CURRENT_RUNS",
"value": 0
}
]
}
]
},
{"id": "3aa06df8-c1e1-4cbd-ae03-6af8c6ec639e",
"discipline": "BOWLING",
"status": "ALL_OUT",
"statistics": [{"type": "TOTAL_OUTS",
"value": 0
},
{"type": "TOTAL_SCORE",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 0
}
],
"appearances": [{"id": "9092d20a-bd8e-4e71-917c-c1eba32ebe16",
"displayOrder": null,
"status": null,
"statistics": [ ]
},
{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"displayOrder": null,
"status": null,
"statistics": [{"type": "CATCHES_AS_WICKET_KEEPER",
"value": 1
},
{"type": "TOTAL_CATCHES",
"value": 2
},
{"type": "CATCHES_AS_FIELDER",
"value": 1
},
{"type": "RUN_OUTS_ASSISTED",
"value": 2
},
{"type": "TOTAL_RUN_OUTS",
"value": 2
}
]
},
{"id": "f78e5e67-4d9f-40c1-8af4-0610e296f8d4",
"displayOrder": 1,
"status": null,
"statistics": [{"type": "CURRENT_BALLS",
"value": 0
},
{"type": "RUNS",
"value": 17
},
{"type": "OVERS",
"value": 1
},
{"type": "WICKETS",
"value": 2
},
{"type": "RUN_OUTS_ASSISTED",
"value": 1
},
{"type": "TOTAL_RUN_OUTS",
"value": 1
},
{"type": "ECONOMY",
"value": 17
},
{"type": "OVERS_BOWLED",
"value": 1
}
]
},
{"id": "9f47825b-ffdf-436f-8faf-3337916e7955",
"displayOrder": null,
"status": null,
"statistics": [ ]
},
{"id": "7be4ebd6-c20e-4f47-8964-96c9a419a8e8",
"displayOrder": 2,
"status": null,
"statistics": [{"type": "RUN_OUTS_ASSISTED",
"value": 1
},
{"type": "TOTAL_RUN_OUTS",
"value": 1
},
{"type": "CURRENT_BALLS",
"value": 1
},
{"type": "RUNS",
"value": 1
},
{"type": "NO_BALLS",
"value": 1
},
{"type": "OVERS",
"value": 0.1
},
{"type": "ECONOMY",
"value": 6
},
{"type": "OVERS_BOWLED",
"value": 0
}
]
}
]
}
],
"sharedStatistics": [{"type": "CAUGHT",
"appearances": [{"id": "7f5d65b4-6dc5-4ac6-8f84-0734605162fc",
"role": "BATTING"
},
{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"role": "FIELDING",
"position": "WICKET_KEEPER"
},
{"id": "f78e5e67-4d9f-40c1-8af4-0610e296f8d4",
"role": "BOWLING"
}
]
},
{"type": "CAUGHT",
"appearances": [{"id": "eddaab8b-30a1-48a6-b91a-104568b07d4b",
"role": "BATTING"
},
{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"role": "FIELDING",
"position": null
},
{"id": "f78e5e67-4d9f-40c1-8af4-0610e296f8d4",
"role": "BOWLING"
}
]
},
{"type": "RUN_OUT",
"appearances": [{"id": "3edc3d3d-37a6-457a-a342-3fa28e01b8dd",
"role": "BATTING"
},
{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"role": "FIELDING",
"position": null
},
{"id": "7be4ebd6-c20e-4f47-8964-96c9a419a8e8",
"role": "ASSISTANT_FIELDING"
}
]
},
{"type": "RUN_OUT",
"appearances": [{"id": "a86c8c04-43b8-4021-8b16-a3400cd0d328",
"role": "BATTING"
},
{"id": "f78e5e67-4d9f-40c1-8af4-0610e296f8d4",
"role": "FIELDING",
"position": null
},
{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"role": "ASSISTANT_FIELDING"
}
]
}
]
},
{"id": "ac087385-c2e9-4cb3-8c56-4cb9890981be",
"name": "FIRST_INNINGS",
"status": "IN_PROGRESS",
"sequenceNo": 2,
"teams": [{"id": "c980b7df-7e1a-40da-a4f8-67c8128c57b0",
"discipline": "BOWLING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 0
},
{"type": "TOTAL_SCORE",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 0
}
],
"appearances": [{"id": "a86c8c04-43b8-4021-8b16-a3400cd0d328",
"displayOrder": null,
"status": null,
"statistics": [{"type": "RUN_OUTS_ASSISTED",
"value": 1
},
{"type": "TOTAL_RUN_OUTS",
"value": 1
}
]
},
{"id": "eddaab8b-30a1-48a6-b91a-104568b07d4b",
"displayOrder": null,
"status": null,
"statistics": [ ]
},
{"id": "3edc3d3d-37a6-457a-a342-3fa28e01b8dd",
"displayOrder": null,
"status": null,
"statistics": [ ]
},
{"id": "7f5d65b4-6dc5-4ac6-8f84-0734605162fc",
"displayOrder": 1,
"status": "BOWLING",
"statistics": [{"type": "CURRENT_BALLS",
"value": 6
},
{"type": "RUN_OUTS_ASSISTED",
"value": 1
},
{"type": "TOTAL_RUN_OUTS",
"value": 1
},
{"type": "OVERS",
"value": 1
},
{"type": "RUNS",
"value": 17
},
{"type": "NO_BALLS",
"value": 1
},
{"type": "WICKETS",
"value": 1
},
{"type": "CATCHES_AS_FIELDER",
"value": 1
},
{"type": "TOTAL_CATCHES",
"value": 1
},
{"type": "ECONOMY",
"value": 17
},
{"type": "OVERS_BOWLED",
"value": 0
}
]
},
{"id": "a3db9276-5d72-4fed-849f-53c6d8c097da",
"displayOrder": null,
"status": null,
"statistics": [ ]
}
]
},
{"id": "3aa06df8-c1e1-4cbd-ae03-6af8c6ec639e",
"discipline": "BATTING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 3
},
{"type": "TOTAL_SCORE",
"value": 18
},
{"type": "TOTAL_OVERS",
"value": 1
},
{"type": "OVER_LIMIT",
"value": 40
},
{"type": "TARGET_SCORE",
"value": 19
},
{"type": "EXTRA_BYES",
"value": 1
},
{"type": "TOTAL_EXTRAS",
"value": 2
},
{"type": "EXTRA_NO_BALLS",
"value": 1
}
],
"appearances": [{"id": "9092d20a-bd8e-4e71-917c-c1eba32ebe16",
"displayOrder": 5,
"status": "ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 0
},
{"type": "CURRENT_RUNS",
"value": 0
}
]
},
{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 1
},
{"type": "CURRENT_RUNS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 0
}
]
},
{"id": "f78e5e67-4d9f-40c1-8af4-0610e296f8d4",
"displayOrder": 1,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 1
},
{"type": "CURRENT_RUNS",
"value": 0
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 0
}
]
},
{"id": "9f47825b-ffdf-436f-8faf-3337916e7955",
"displayOrder": 4,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 4
},
{"type": "CURRENT_RUNS",
"value": 16
},
{"type": "BALLS_FACED",
"value": 4
},
{"type": "TOTAL_RUNS",
"value": 16
},
{"type": "SIXES",
"value": 2
},
{"type": "FOURS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 400
}
]
},
{"id": "7be4ebd6-c20e-4f47-8964-96c9a419a8e8",
"displayOrder": 3,
"status": "NOT_ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 0
},
{"type": "CURRENT_RUNS",
"value": 0
}
]
}
]
}
],
"sharedStatistics": [{"type": "RUN_OUT",
"appearances": [{"id": "f78e5e67-4d9f-40c1-8af4-0610e296f8d4",
"role": "BATTING"
},
{"id": "a86c8c04-43b8-4021-8b16-a3400cd0d328",
"role": "FIELDING",
"position": null
},
{"id": "7f5d65b4-6dc5-4ac6-8f84-0734605162fc",
"role": "ASSISTANT_FIELDING"
}
]
},
{"type": "HIT_BALL_TWICE",
"appearances": [{"id": "23cefde5-f141-4cd1-b8db-2cae73258edb",
"role": "BATTING"
}
]
},
{"type": "CAUGHT",
"appearances": [{"id": "9f47825b-ffdf-436f-8faf-3337916e7955",
"role": "BATTING"
},
{"id": "7f5d65b4-6dc5-4ac6-8f84-0734605162fc",
"role": "FIELDING",
"position": null
},
{"id": "7f5d65b4-6dc5-4ac6-8f84-0734605162fc",
"role": "BOWLING"
}
]
}
]
}
]
}
}

Live Game Score Event Webhook

This event is only applicable to Cricket and is now deprecated, please refer to LIVE_GAME.EVENT. Please note, although this event is now deprecated, it will be kept up to date for future enhancements.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "LIVE_GAME.SCORE_EVENT"
	object

Responses

Request samples

Payload

Content type

application/json

Example

{"messageId": "e96df3a8-88e2-4254-b323-70a2b4f3bbb1",
"eventType": "LIVE_GAME.SCORE_EVENT",
"entityId": "59382773-98b5-407f-96dd-e6a65f2b9241",
"eventRaisedDateTime": "2022-09-21T15:51:49.866Z",
"data": {"eventId": "7a2c2c49-cdf7-44d8-ab6d-a0fcc246aec3",
"gameId": "8c360b68-f723-4a2c-8ee3-cf80fab86a8f",
"timestamp": "2022-09-21T15:51:48.461Z",
"eventStartTimestamp": null,
"gameTime": [{"type": "OVER_NUMBER",
"value": 1
},
{"type": "TOTAL_BALLS",
"value": 4
},
{"type": "LEGAL_BALLS",
"value": 4
}
],
"event": {"type": "BALL",
"properties": [ ],
"appearances": [{"id": "3d6bc8a0-8ad6-4e88-8ed2-5e0f8b58f23b",
"role": "BATTING",
"statistics": [{"type": "RUNS",
"value": 4
}
]
},
{"id": "726b6ac6-aaae-4d95-b98b-63bd6edbd088",
"role": "BOWLING",
"statistics": null
}
],
"teams": null,
"sharedStatistics": [ ]
},
"periods": [{"id": "590bdcf8-c3f8-4d25-9748-4a4092ebc36a",
"name": "FIRST_INNINGS",
"status": "IN_PROGRESS",
"sequenceNo": 1,
"teams": [{"id": "3bc33086-28eb-4be7-89e1-94608f6f86a8",
"discipline": "BATTING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 1
},
{"type": "TOTAL_SCORE",
"value": 17
},
{"type": "TOTAL_OVERS",
"value": 1.4
},
{"type": "OVER_LIMIT",
"value": 0
},
{"type": "TOTAL_EXTRAS",
"value": 4
},
{"type": "EXTRA_LEG_BYES",
"value": 1
},
{"type": "EXTRA_WIDES",
"value": 1
},
{"type": "EXTRA_NO_BALLS",
"value": 1
},
{"type": "EXTRA_BYES",
"value": 1
}
],
"appearances": [{"id": "532698e9-3a1f-4148-a20d-a1ba65337903",
"displayOrder": 2,
"status": "NOT_ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 5
},
{"type": "CURRENT_RUNS",
"value": 5
},
{"type": "BALLS_FACED",
"value": 5
},
{"type": "TOTAL_RUNS",
"value": 5
},
{"type": "STRIKE_RATE",
"value": 100
}
]
},
{"id": "3d6bc8a0-8ad6-4e88-8ed2-5e0f8b58f23b",
"displayOrder": 3,
"status": "ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 2
},
{"type": "CURRENT_RUNS",
"value": 7
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 7
},
{"type": "FOURS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 350
}
]
}
]
},
{"id": "29e168e0-ac0d-4942-b1df-944a16aff324",
"discipline": "BOWLING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 0
},
{"type": "TOTAL_SCORE",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 0
}
],
"appearances": [{"id": "726b6ac6-aaae-4d95-b98b-63bd6edbd088",
"displayOrder": 2,
"status": "BOWLING",
"statistics": [{"type": "CURRENT_BALLS",
"value": 4
},
{"type": "RUNS",
"value": 6
},
{"type": "WIDES",
"value": 1
},
{"type": "OVERS",
"value": 0.4
},
{"type": "NO_BALLS",
"value": 1
},
{"type": "ECONOMY",
"value": 9
},
{"type": "OVERS_BOWLED",
"value": 0
}
]
}
]
}
]
},
{"id": "fa653ab3-23f0-471e-a2dc-9b4606886ee7",
"name": "FIRST_INNINGS",
"sequenceNo": 2,
"teams": [{"id": "f4593647-4b83-492a-bb9a-abfa85c5b2d4",
"discipline": "BOWLING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 1
},
{"type": "TOTAL_SCORE",
"value": 7
},
{"type": "TOTAL_OVERS",
"value": 0.5
},
{"type": "OVER_LIMIT",
"value": 0
},
{"type": "EXTRA_WIDES",
"value": 1
}
],
"appearances": [{"id": "1a2805ac-0b46-437a-b765-6855aba77273",
"displayOrder": 1,
"status": "ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 3
},
{"type": "CURRENT_RUNS",
"value": 4
},
{"type": "BALLS_FACED",
"value": 3
},
{"type": "TOTAL_RUNS",
"value": 4
},
{"type": "STRIKE_RATE",
"value": 133.33
}
]
},
{"id": "21fe7f3b-c528-4f44-8f54-0168b0be319a",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 1
},
{"type": "CURRENT_RUNS",
"value": 2
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "TOTAL_RUNS",
"value": 2
},
{"type": "STRIKE_RATE",
"value": 200
}
]
}
]
},
{"id": "5fb4a15b-23c3-4496-a23e-b09bd4ea4059",
"discipline": "BATTING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 0
},
{"type": "TOTAL_SCORE",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 0
}
],
"appearances": [{"id": "738a11b6-7a70-4389-8eb2-7b7614df324c",
"displayOrder": 1,
"status": "BOWLING",
"statistics": [{"type": "RUNS",
"value": 7
},
{"type": "OVERS",
"value": 0.5
},
{"type": "WIDES",
"value": 1
},
{"type": "ECONOMY",
"value": 8.4
},
{"type": "OVERS_BOWLED",
"value": 0
}
]
}
]
}
]
}
]
}
}

Live Game Event Webhook

The Live Game Event webhook captures real-time statistic events, e.g. score/ball/foul/card, game time related events, e.g. start period/break/clock, and DLS adjustments during a live scored game. The statistic related events also provide the progressive score for the innings/game as a result of the statistic event. The following statistic related events are NOT included in this event: Cards/Fouls recorded against a team and any statistics entered against a coach role type. Please note, this event is applicable to all sports.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "LIVE_GAME.EVENT"
	object

Responses

Request samples

Payload

Content type

application/json

Example

{"messageId": "e96df3a8-88e2-4254-b323-70a2b4f3bbb1",
"eventType": "LIVE_GAME.EVENT",
"entityId": "59382773-98b5-407f-96dd-e6a65f2b9241",
"eventRaisedDateTime": "2022-09-21T15:51:49.866Z",
"data": {"eventId": "7a2c2c49-cdf7-44d8-ab6d-a0fcc246aec3",
"gameId": "8c360b68-f723-4a2c-8ee3-cf80fab86a8f",
"timestamp": "2022-09-21T15:51:48.461Z",
"eventStartTimestamp": null,
"gameTime": [{"type": "OVER_NUMBER",
"value": 1
},
{"type": "TOTAL_BALLS",
"value": 4
},
{"type": "LEGAL_BALLS",
"value": 4
}
],
"event": {"type": "BALL",
"properties": [ ],
"appearances": [{"id": "3d6bc8a0-8ad6-4e88-8ed2-5e0f8b58f23b",
"role": "BATTING",
"statistics": [{"type": "RUNS",
"value": 4
}
]
},
{"id": "726b6ac6-aaae-4d95-b98b-63bd6edbd088",
"role": "BOWLING",
"statistics": null
}
],
"teams": null,
"sharedStatistics": [ ]
},
"periods": [{"id": "590bdcf8-c3f8-4d25-9748-4a4092ebc36a",
"name": "FIRST_INNINGS",
"status": "IN_PROGRESS",
"sequenceNo": 1,
"teams": [{"id": "3bc33086-28eb-4be7-89e1-94608f6f86a8",
"discipline": "BATTING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 1
},
{"type": "TOTAL_SCORE",
"value": 17
},
{"type": "TOTAL_OVERS",
"value": 1.4
},
{"type": "OVER_LIMIT",
"value": 0
},
{"type": "TOTAL_EXTRAS",
"value": 4
},
{"type": "EXTRA_LEG_BYES",
"value": 1
},
{"type": "EXTRA_WIDES",
"value": 1
},
{"type": "EXTRA_NO_BALLS",
"value": 1
},
{"type": "EXTRA_BYES",
"value": 1
}
],
"appearances": [{"id": "532698e9-3a1f-4148-a20d-a1ba65337903",
"displayOrder": 2,
"status": "NOT_ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 5
},
{"type": "CURRENT_RUNS",
"value": 5
},
{"type": "BALLS_FACED",
"value": 5
},
{"type": "TOTAL_RUNS",
"value": 5
},
{"type": "STRIKE_RATE",
"value": 100
}
]
},
{"id": "3d6bc8a0-8ad6-4e88-8ed2-5e0f8b58f23b",
"displayOrder": 3,
"status": "ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 2
},
{"type": "CURRENT_RUNS",
"value": 7
},
{"type": "BALLS_FACED",
"value": 2
},
{"type": "TOTAL_RUNS",
"value": 7
},
{"type": "FOURS",
"value": 1
},
{"type": "STRIKE_RATE",
"value": 350
}
]
}
]
},
{"id": "29e168e0-ac0d-4942-b1df-944a16aff324",
"discipline": "BOWLING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 0
},
{"type": "TOTAL_SCORE",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 0
}
],
"appearances": [{"id": "726b6ac6-aaae-4d95-b98b-63bd6edbd088",
"displayOrder": 2,
"status": "BOWLING",
"statistics": [{"type": "CURRENT_BALLS",
"value": 4
},
{"type": "RUNS",
"value": 6
},
{"type": "WIDES",
"value": 1
},
{"type": "OVERS",
"value": 0.4
},
{"type": "NO_BALLS",
"value": 1
},
{"type": "ECONOMY",
"value": 9
},
{"type": "OVERS_BOWLED",
"value": 0
}
]
}
]
}
]
},
{"id": "fa653ab3-23f0-471e-a2dc-9b4606886ee7",
"name": "FIRST_INNINGS",
"sequenceNo": 2,
"teams": [{"id": "f4593647-4b83-492a-bb9a-abfa85c5b2d4",
"discipline": "BOWLING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 1
},
{"type": "TOTAL_SCORE",
"value": 7
},
{"type": "TOTAL_OVERS",
"value": 0.5
},
{"type": "OVER_LIMIT",
"value": 0
},
{"type": "EXTRA_WIDES",
"value": 1
}
],
"appearances": [{"id": "1a2805ac-0b46-437a-b765-6855aba77273",
"displayOrder": 1,
"status": "ON_STRIKE",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 3
},
{"type": "CURRENT_RUNS",
"value": 4
},
{"type": "BALLS_FACED",
"value": 3
},
{"type": "TOTAL_RUNS",
"value": 4
},
{"type": "STRIKE_RATE",
"value": 133.33
}
]
},
{"id": "21fe7f3b-c528-4f44-8f54-0168b0be319a",
"displayOrder": 2,
"status": "OUT",
"statistics": [{"type": "CURRENT_BALLS_FACED",
"value": 1
},
{"type": "CURRENT_RUNS",
"value": 2
},
{"type": "BALLS_FACED",
"value": 1
},
{"type": "TOTAL_RUNS",
"value": 2
},
{"type": "STRIKE_RATE",
"value": 200
}
]
}
]
},
{"id": "5fb4a15b-23c3-4496-a23e-b09bd4ea4059",
"discipline": "BATTING",
"status": null,
"statistics": [{"type": "TOTAL_OUTS",
"value": 0
},
{"type": "TOTAL_SCORE",
"value": 0
},
{"type": "TOTAL_OVERS",
"value": 0
},
{"type": "OVER_LIMIT",
"value": 0
}
],
"appearances": [{"id": "738a11b6-7a70-4389-8eb2-7b7614df324c",
"displayOrder": 1,
"status": "BOWLING",
"statistics": [{"type": "RUNS",
"value": 7
},
{"type": "OVERS",
"value": 0.5
},
{"type": "WIDES",
"value": 1
},
{"type": "ECONOMY",
"value": 8.4
},
{"type": "OVERS_BOWLED",
"value": 0
}
]
}
]
}
]
}
]
}
}

Live Game Event Undo Webhook

The Live Game Event Undo Webhook captures undo events or events that have been removed during a live scoring game.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "LIVE_GAME.EVENT_UNDO"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "f3fa5953-d0bd-4d7e-bbba-851300f006ad",
"eventType": "LIVE_GAME.EVENT_UNDO",
"entityId": "3b7fbbfb-8abd-479d-a31e-9db44514026d",
"eventRaisedDateTime": "2022-06-28T00:39:32.493Z",
"data": {"id": "3b7fbbfb-8abd-479d-a31e-9db44514026d",
"deletedEventId": "b95d81cb-2c30-43bf-9d21-5300bb4e5de6",
"gameId": "96f15964-d3c8-4c4b-bae2-2cbea5984414"
}
}

Live Game Detail Updated Webhook

Live Game Detail webhook captures updates to the toss and/or lineup for a live scoring game. This will always be the first event for a live scored game and will also trigger at the start of each period and for any changes to the lineup.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "LIVE_GAME.DETAIL_UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

Example

{"messageId": "12d5f1f1-49ea-422c-bfb0-33a8eb3f2e38",
"eventType": "LIVE_GAME.DETAIL_UPDATED",
"entityId": "dd5cdf44-3fa3-4885-bc7f-79edade26124",
"eventRaisedDateTime": "2022-06-29T19:26:22.546Z",
"data": {"id": "77b19fca-09d2-4170-b187-4a77471055c3",
"gradeId": "b76d8593-59d0-4455-b2d4-86ca5b19b98d",
"status": "LIVE",
"type": "ONE_DAY",
"appearances": [{"id": "efc1c2d8-2e66-4edb-b61f-e03a9a1fa371",
"firstName": "Brent",
"lastName": "Murphy",
"playerNumber": null,
"visible": false,
"teamId": "d6c41f91-0118-4890-9caf-76394d415103",
"isFillIn": true,
"roleType": "Player",
"isRegisteredPlayer": false,
"playerPosition": null,
"captainRole": null
},
{"id": "841e2a37-23bc-4dc2-b70a-8b37d6001b29",
"firstName": "Isabella",
"lastName": "Franks",
"playerNumber": null,
"visible": true,
"teamId": "d6c41f91-0118-4890-9caf-76394d415103",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "a141a948-7664-4fdd-bbee-6a129ef25abb",
"firstName": "Olympia",
"lastName": "Long",
"playerNumber": null,
"visible": true,
"teamId": "d6c41f91-0118-4890-9caf-76394d415103",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "333c71be-7630-4f6d-be1f-71ec2e51e8c3",
"firstName": "Riley",
"lastName": "Banks",
"playerNumber": null,
"visible": true,
"teamId": "d6c41f91-0118-4890-9caf-76394d415103",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "30609784-9e3c-4843-8bf1-319a26de2c36",
"firstName": "Robin",
"lastName": "Livingston",
"playerNumber": null,
"visible": true,
"teamId": "d6c41f91-0118-4890-9caf-76394d415103",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "c4d68a29-f66c-4ec2-ba94-13ea75a16181",
"firstName": "Avram",
"lastName": "Nash",
"playerNumber": null,
"visible": true,
"teamId": "e25de075-720e-4328-8342-f7188d4f3817",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "ab5fb0c4-d2ab-4f95-8e9a-f2c9d2fefeaf",
"firstName": "Cara",
"lastName": "Rodriquez",
"playerNumber": null,
"visible": true,
"teamId": "e25de075-720e-4328-8342-f7188d4f3817",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "efc89db7-464c-4872-bc47-0c9747d3ab64",
"firstName": "Castor",
"lastName": "Britt",
"playerNumber": null,
"visible": true,
"teamId": "e25de075-720e-4328-8342-f7188d4f3817",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": null,
"captainRole": null
},
{"id": "717b6379-1c9e-4639-8e5e-077f966206b6",
"firstName": "Karyn",
"lastName": "Blevins",
"playerNumber": null,
"visible": false,
"teamId": "e25de075-720e-4328-8342-f7188d4f3817",
"isFillIn": true,
"roleType": "Player",
"isRegisteredPlayer": false,
"playerPosition": null,
"captainRole": "CAPTAIN"
},
{"id": "2a0615c4-22cb-4ff6-848e-8ee410ce3d26",
"firstName": "Micah",
"lastName": "Burt",
"playerNumber": null,
"visible": true,
"teamId": "e25de075-720e-4328-8342-f7188d4f3817",
"isFillIn": false,
"roleType": "Player",
"isRegisteredPlayer": true,
"playerPosition": "WICKET_KEEPER",
"captainRole": "VICE_CAPTAIN"
}
],
"teams": [{"id": "d6c41f91-0118-4890-9caf-76394d415103",
"name": "t20_2",
"isHomeTeam": true
},
{"id": "e25de075-720e-4328-8342-f7188d4f3817",
"name": "t20_3",
"isHomeTeam": false
}
],
"coinToss": {"winningTeamId": "d6c41f91-0118-4890-9caf-76394d415103",
"preference": "BAT"
}
}
}

Live Game Reset Webhook

Live Game Reset webhook captures real-time game reset event during for a live scoring game.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "LIVE_GAME.RESET"
	object

Request samples

Payload

Content type

application/json

{"data": {"id": "6eac8895-5e6e-4591-bfa8-173bf004e5e4",
"gameId": "b2f5cc40-e3e0-4609-b97c-63c72a03c018"
}
}

Programs

Program Created Webhook

Information about a new program created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "0eb00157-4a31-4bcb-8dc9-29081bfeab6c",
"eventType": "PROGRAM.CREATED",
"entityId": "0bbc7c2b-8ebe-4730-8c00-936f1e66d54f",
"eventRaisedDateTime": "2021-03-15T11:24:50.740Z",
"data": {"id": "0bbc7c2b-8ebe-4730-8c00-936f1e66d54f",
"name": "PC 2021 Program",
"organisationId": "54668204-9ca1-4ea2-b5c2-461fea41a44d",
"description": "This is a test Program",
"shared": false,
"format": "",
"eventRaisedDateTime": "2021-03-15T11:24:50.740Z"
}
}

Program Updated Webhook

Information about a program updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "84f1d53b-bcea-4505-b2cb-b89fc9dbb522",
"eventType": "PROGRAM.UPDATED",
"entityId": "0bbc7c2b-8ebe-4730-8c00-936f1e66d54f",
"eventRaisedDateTime": "2021-03-15T11:25:14.768Z",
"data": {"id": "0bbc7c2b-8ebe-4730-8c00-936f1e66d54f",
"name": "PC 2021 Program EDITED",
"organisationId": "54668204-9ca1-4ea2-b5c2-461fea41a44d",
"description": "This is a test Program EDITED",
"shared": false,
"format": "",
"eventRaisedDateTime": "2021-03-15T11:25:14.768Z"
}
}

Program Deleted Webhook

Information about a program deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "591073c3-97c9-4cc3-9cfa-dcd0c00e6a1b",
"eventType": "PROGRAM.DELETED",
"entityId": "0bbc7c2b-8ebe-4730-8c00-936f1e66d54f",
"eventRaisedDateTime": "2021-03-15T11:25:30.080Z",
"data": {"id": "0bbc7c2b-8ebe-4730-8c00-936f1e66d54f",
"eventRaisedDateTime": "2021-03-15T11:25:30.080Z"
}
}

Program Alias Names Updated Webhook

Information about a Program Alias Names Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_ALIAS.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "c5a41d6a-162e-41a4-bfbb-e24d18c4ce7b",
"eventType": "PROGRAM_ALIAS.UPDATED",
"entityId": "05e7bda6-779a-4bf8-84fb-d8500a69c90f",
"eventRaisedDateTime": "2021-03-23T00:10:32.959Z",
"data": {"id": "05e7bda6-779a-4bf8-84fb-d8500a69c90f",
"programId": "05e7bda6-779a-4bf8-84fb-d8500a69c90f",
"eventRaisedDateTime": "2021-03-23T00:10:32.959Z",
"organisationId": "d3676408-62b9-475e-b504-705f4d8e3003",
"programAliasName": "Test Alias Name"
}
}

Program Seasons

Program Season Created Webhook

Information about a new program season created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "96f3c7d0-1e26-4362-ac6c-2004fc239cc6",
"eventType": "PROGRAM_SEASON.CREATED",
"entityId": "068a62e8-cf9d-470f-b2f2-b08eac8c352e",
"eventRaisedDateTime": "2021-03-22T23:43:08.407Z",
"data": {"id": "068a62e8-cf9d-470f-b2f2-b08eac8c352e",
"name": 2021,
"programId": "7686fbbd-cfdb-40ca-8f5b-0c72a2acd8c9",
"startDate": "2021-04-01",
"endDate": "2021-04-30",
"launchStatus": true,
"eventRaisedDateTime": "2021-03-22T23:43:08.407Z",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"sessionCount": 2,
"gender": "MIXED",
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Program Season Updated Webhook

Information about a new program season updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "96f3c7d0-1e26-4362-ac6c-2004fc239cc6",
"eventType": "PROGRAM_SEASON.CREATED",
"entityId": "068a62e8-cf9d-470f-b2f2-b08eac8c352e",
"eventRaisedDateTime": "2021-03-22T23:43:08.407Z",
"data": {"id": "068a62e8-cf9d-470f-b2f2-b08eac8c352e",
"name": 2021,
"programId": "7686fbbd-cfdb-40ca-8f5b-0c72a2acd8c9",
"startDate": "2021-04-01",
"endDate": "2021-04-30",
"launchStatus": true,
"eventRaisedDateTime": "2021-03-22T23:43:08.407Z",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"sessionCount": 2,
"gender": "MIXED",
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Program Season Deleted Webhook

Information about a program season deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "faceaee0-1236-46d1-8985-28c36e779bc4",
"eventType": "PROGRAM_SEASON.DELETED",
"entityId": "068a62e8-cf9d-470f-b2f2-b08eac8c352e",
"eventRaisedDateTime": "2021-03-22T23:51:16.000Z",
"data": {"id": "068a62e8-cf9d-470f-b2f2-b08eac8c352e",
"eventRaisedDateTime": "2021-03-22T23:51:16.000Z"
}
}

Local Program Season Organisation Participated Webhook

Information about a Local Program Season Organisation Participated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "LOCAL_PROGRAM_SEASON.ORGANISATION_PARTICIPATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "c15dbe5f-993b-4043-837c-4fda369508b8",
"eventType": "LOCAL_PROGRAM_SEASON.ORGANISATION_PARTICIPATED",
"entityId": "b6911d25-ed46-4ccd-b225-36d41cb9ebe7",
"eventRaisedDateTime": "2022-09-09T16:20:09.598Z",
"data": {"organisationId": "b6911d25-ed46-4ccd-b225-36d41cb9ebe7",
"seasonId": "ede93184-b920-433f-93be-69ea79af3381",
"seasonStartDate": "2022-09-01",
"seasonEndDate": "2022-12-31",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"sessionCount": 2,
"gender": "MIXED",
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Local Program Season Date Updated Webhook

Information about a Local Program Season Date Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "LOCAL_PROGRAM_SEASON.DATE_UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "d83a502f-e526-42d4-afaf-ae886990d0d4",
"eventType": "LOCAL_PROGRAM_SEASON.DATE_UPDATED",
"entityId": "b6911d25-ed46-4ccd-b225-36d41cb9ebe7",
"eventRaisedDateTime": "2022-09-11T19:44:22.212Z",
"data": {"organisationId": "b6911d25-ed46-4ccd-b225-36d41cb9ebe7",
"seasonId": "ede93184-b920-433f-93be-69ea79af3381",
"seasonStartDate": "2022-09-01",
"seasonEndDate": "2022-12-31",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"sessionCount": 2,
"gender": "MIXED",
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Shared Program Season Date Updated Webhook

Information about a Shared Program Season Date Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "SHARED_PROGRAM_SEASON.DATE_UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "74670b3d-e581-4e9a-b91b-5eb7adc1ab30",
"eventType": "SHARED_PROGRAM_SEASON.DATE_UPDATED",
"entityId": "db652b97-4c97-4949-a919-515a37926f97",
"eventRaisedDateTime": "2022-09-11T19:39:30.638Z",
"data": {"organisationId": "bc86c47b-26d6-432f-a315-af9f4a413f28",
"seasonId": "1588add6-8928-44af-8772-fe962a521eda",
"seasonStartDate": "2022-09-01",
"seasonEndDate": "2022-11-30",
"sessionCount": 2,
"gender": "MIXED",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Shared Program Season Shared Status On Webhook

Information about a Shared Program Season Shared Status On

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "SHARED_PROGRAM_SEASON.SHARE_STATUS_ON"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "60329482-363b-4122-b871-0946d0c3f7d8",
"eventType": "SHARED_PROGRAM_SEASON.SHARE_STATUS_ON",
"entityId": "e0c27342-4c64-48b0-b21c-75e365975199",
"eventRaisedDateTime": "2022-09-09T16:14:14.050Z",
"data": {"organisationId": "bc86c47b-26d6-432f-a315-af9f4a413f28",
"seasonId": "e0c27342-4c64-48b0-b21c-75e365975199",
"seasonStartDate": "2022-09-01",
"seasonEndDate": "2022-12-31",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"sessionCount": 2,
"gender": "MIXED",
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Shared Program Season Shared Status Off Webhook

Information about a Shared Program Season Shared Status Off

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "SHARED_PROGRAM_SEASON.SHARE_STATUS_OFF"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "a04e1c31-b628-44be-b80f-f87c1502feea",
"eventType": "SHARED_PROGRAM_SEASON.SHARE_STATUS_OFF",
"entityId": "e0c27342-4c64-48b0-b21c-75e365975199",
"eventRaisedDateTime": "2022-09-09T16:16:51.523Z",
"data": {"organisationId": "b6911d25-ed46-4ccd-b225-36d41cb9ebe7",
"seasonId": "e0c27342-4c64-48b0-b21c-75e365975199",
"seasonStartDate": "2022-09-01",
"seasonEndDate": "2022-12-31",
"daySessions": [{"day": "WEDNESDAY",
"startTime": "09:00:00",
"endTime": "10:00:00"
},
{"day": "THURSDAY"
}
],
"sessionCount": 2,
"gender": "MIXED",
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32
}
}

Program Season Groups

Program Season Group Created Webhook

Information about a new program season group created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON_GROUP.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "50f0dbaa-dd16-45d6-9646-29cf4530d404",
"eventType": "PROGRAM_SEASON_GROUP.CREATED",
"entityId": "48af5aa9-886e-4da9-95e3-98172c75477b",
"eventRaisedDateTime": "2021-03-22T23:55:31.034Z",
"data": {"id": "48af5aa9-886e-4da9-95e3-98172c75477b",
"eventRaisedDateTime": "2021-03-22T23:55:31.034Z",
"organisationId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"programId": "eeeb01b3-646c-4eeb-859c-5cc758ed647d",
"seasonId": "7e0ed7bb-6f42-417d-8c0f-7b2a3b4086e9",
"name": "Morning Group - Daily",
"days": ["MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"sessionCount": 10,
"gender": "MIXED",
"startDate": "2021-04-03",
"startTime": "09:30:00",
"endTime": "17:30:00",
"visible": true,
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32,
"daySessions": [{"day": "SUNDAY",
"endTime": "15:30:00",
"startTime": "09:00:00"
},
{"day": "THURSDAY"
}
]
}
}

Program Season Group Updated Webhook

Information about a new program season group updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON_GROUP.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "50f0dbaa-dd16-45d6-9646-29cf4530d404",
"eventType": "PROGRAM_SEASON_GROUP.CREATED",
"entityId": "48af5aa9-886e-4da9-95e3-98172c75477b",
"eventRaisedDateTime": "2021-03-22T23:55:31.034Z",
"data": {"id": "48af5aa9-886e-4da9-95e3-98172c75477b",
"eventRaisedDateTime": "2021-03-22T23:55:31.034Z",
"organisationId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"programId": "eeeb01b3-646c-4eeb-859c-5cc758ed647d",
"seasonId": "7e0ed7bb-6f42-417d-8c0f-7b2a3b4086e9",
"name": "Morning Group - Daily",
"days": ["MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"sessionCount": 10,
"gender": "MIXED",
"startDate": "2021-04-03",
"startTime": "09:30:00",
"endTime": "17:30:00",
"visible": true,
"venueId": "520c2351-8903-458b-ba13-798663a30f8a",
"venueName": "my first venue",
"venueLatitude": 32,
"venueLongitude": -32,
"playingSurfaceId": "d202c1e0-916d-4914-b0ee-c3c96f3f5b3a",
"playingSurfaceName": "another court",
"playingSurfaceLatitude": 32,
"playingSurfaceLongitude": -32,
"daySessions": [{"day": "SUNDAY",
"endTime": "15:30:00",
"startTime": "09:00:00"
},
{"day": "THURSDAY"
}
]
}
}

Program Season Group Deleted Webhook

Information about a program season group deleted

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON_GROUP.DELETED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "1f95fcc3-0791-476c-bbdb-d5d0e93a99e6",
"eventType": "PROGRAM_SEASON_GROUP.DELETED",
"entityId": "48af5aa9-886e-4da9-95e3-98172c75477b",
"eventRaisedDateTime": "2021-03-22T23:58:16.400Z",
"data": {"id": "48af5aa9-886e-4da9-95e3-98172c75477b",
"eventRaisedDateTime": "2021-03-22T23:58:16.400Z"
}
}

Program Season Registration Forms

Program Season Registration Form Created Webhook

Information about a Program Season Registration Form Created

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON_REGISTRATION_FORM.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "e5cf65b0-0127-4ecc-be63-83496a095b3a",
"eventType": "PROGRAM_SEASON_REGISTRATION_FORM.CREATED",
"entityId": "71909875-f2e0-4b08-91a0-ad0611c9dd3e",
"eventRaisedDateTime": "2021-03-23T00:01:20.868Z",
"data": {"id": "71909875-f2e0-4b08-91a0-ad0611c9dd3e",
"eventRaisedDateTime": "2021-03-23T00:01:20.868Z",
"programId": "14e68b8e-8d8d-4d2a-ac6c-01854ef7a01e",
"seasonId": "1702789b-9879-467f-8152-b4c26a2933d3",
"organisationId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"startDateTime": "2021-02-28T21:30:00.000Z",
"endDateTime": "2021-03-31T05:30:00.000Z",
"formUrl": "https://www.wizards.playhq.com/afl/register/526645",
"visible": false,
"agerestrictions": {"calculateAgeOfPlayerAsAtDate": "date",
"agefrom": 5,
"ageto": 10
},
"fee": [{"type": "Advanced",
"orgId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"role": "Participant",
"amount": 50,
"description": "Group 1",
"ageAsAtDate": "date",
"ageMin": 3,
"ageMax": 6,
"gender": "ALL"
},
{"type": "Base",
"orgId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"role": "Participant",
"amount": 30,
"description": "Player Fee"
},
{"type": "Group",
"orgId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"role": "Participant",
"amount": 10,
"description": "Group Fee",
"groupId": "12456254-d15b-4aba-8028-59c9beaba111"
}
]
}
}

Program Season Registration Form Updated Webhook

Information about a Program Season Registration Form Updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROGRAM_SEASON_REGISTRATION_FORM.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "e5cf65b0-0127-4ecc-be63-83496a095b3a",
"eventType": "PROGRAM_SEASON_REGISTRATION_FORM.CREATED",
"entityId": "71909875-f2e0-4b08-91a0-ad0611c9dd3e",
"eventRaisedDateTime": "2021-03-23T00:01:20.868Z",
"data": {"id": "71909875-f2e0-4b08-91a0-ad0611c9dd3e",
"eventRaisedDateTime": "2021-03-23T00:01:20.868Z",
"programId": "14e68b8e-8d8d-4d2a-ac6c-01854ef7a01e",
"seasonId": "1702789b-9879-467f-8152-b4c26a2933d3",
"organisationId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"startDateTime": "2021-02-28T21:30:00.000Z",
"endDateTime": "2021-03-31T05:30:00.000Z",
"formUrl": "https://www.wizards.playhq.com/afl/register/526645",
"visible": false,
"agerestrictions": {"calculateAgeOfPlayerAsAtDate": "date",
"agefrom": 5,
"ageto": 10
},
"fee": [{"type": "Advanced",
"orgId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"role": "Participant",
"amount": 50,
"description": "Group 1",
"ageAsAtDate": "date",
"ageMin": 3,
"ageMax": 6,
"gender": "ALL"
},
{"type": "Base",
"orgId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"role": "Participant",
"amount": 30,
"description": "Player Fee"
},
{"type": "Group",
"orgId": "4ad4832b-d15b-4aba-8028-59c9beaba49e",
"role": "Participant",
"amount": 10,
"description": "Group Fee",
"groupId": "12456254-d15b-4aba-8028-59c9beaba111"
}
]
}
}

Program Season Registrations

Shared Program Registrations Webhook

Information about a Shared Program Registrations

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "SHARED_PROGRAM_REGISTRATION.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "e50b0893-f1f6-41e9-9ee5-19d6b51981cb",
"entityId": "a77bee3c-30f2-11ec-8d3d-0242ac130003",
"eventRaisedDateTime": "string",
"eventType": "SHARED_PROGRAM_REGISTRATION.CREATED",
"data": {"id": "58d9e86a-f73c-11ea-adc1-0242ac120002",
"eventRaisedDateTime": "2021-04-13T07:52:58.650Z",
"profile": {"id": "58d9e86a-f73c-11ea-adc1-0242ac120002",
"wwc": {"number": "ABCD1234",
"expiryDate": "20/05/2020",
"stateOfIssue": "Australian Capital Territory"
},
"accountHolder": true,
"accountHolderExternalAccountId": "440685da-f7bc-11ea-adc1-0242ac120002",
"accountHolderProfileId": "58d9e86a-f73c-11ea-adc1-0242ac120002",
"accountHolderEmailAddress": "test@email.com",
"accountHolderMobile": 61,
"accountHolderMobileCountryCode": 575218834,
"participant": {"firstName": "Jane",
"lastName": "Doe",
"dateOfBirth": "27/04/2015",
"gender": "Female",
"address": "123 St.",
"suburb": "Hillarys",
"postcode": 6025,
"state": "WA",
"country": "Australia",
"emailAddress": "test@email.com",
"mobilePhone": 61,
"mobileCountryCode": 422220222
},
"profileVisible": "Yes",
"parentGuardiansBornOverseas": "All Countries in alpha order",
"parentGuardian1CountryOfBirth": "All Countries in alpha order",
"parentGuardian2CountryOfBirth": "Yes",
"hasDisability": "Attention Deficit Hyperactivity Disorder (ADHD)",
"disabilities": [ ],
"otherDisabilityDescription": "Disability entails the following…",
"additionalDisabilitySupportInformation": "My disability can best be supported by…",
"atsi": "ABORIGINAL",
"parentGuardians": [{"firstName": "John",
"lastName": "Doe",
"mobilePhone": 74299099,
"mobileCountryCode": 61,
"emailAddress": "test@email.com",
"address": "123 St.",
"suburb": "Hillarys",
"postcode": 6025,
"state": "WA",
"country": "Australia"
}
],
"emergencyContact": {"firstName": "Jane",
"lastName": "Doe",
"mobile": 74336539,
"mobileCountryCode": 61,
"emailAddress": "anothertest@test.com",
"relationship": "Mother"
},
"createdAt": "2020-08-27T06:29:54.400Z",
"updatedAt": "2020-08-27T06:29:54.400Z",
"externalAccountId": "440685da-f7bc-11ea-adc1-0242ac120002"
},
"registration": {"id": "9f7f5a82-f7bb-11ea-adc1-0242ac120002",
"previousRegistrationId": "234fsd6a-543c-15a-a321-054dfg22002",
"participantProfileId": "58d9e86a-f73c-11ea-adc1-0242ac120002",
"sharedProgramRegisteredToId": "440685da-f7bc-11ea-adc1-0242ac120002",
"organisationRegisteredToId": "26c3d626-f7bc-11ea-adc1-0242ac120002",
"programSeason": {"name": 2020,
"startDate": "01/05/2020",
"endDate": "30/09/2020"
},
"registrationDate": "2020-08-27T06:29:54.400Z",
"role": "Player",
"registrationStatus": "Active",
"participantDateOfBirth": "27/04/2015",
"participantGender": "Female",
"schoolId": 45674,
"schoolYear": "Kindergarten",
"optInMarketing": "TRUE or FALSE",
"createdAt": "2020-08-27T06:29:54.400Z",
"updatedAt": "2020-08-27T06:29:54.400Z"
}
}
}

Profiles

Lists profile’s dependants (Private)

Retrieve basic dependant details related to a submitted profileId. Only dependants that have previously registered to participate in the tenant you have access to will be returned.

path Parameters

required

string

ID of the profile

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"dependants": [{"id": "835354f5-e0a2-4cf3-b508-b12e2d6b14d2",
"firstName": "Nina",
"lastName": "Benjamin",
"visible": true,
"gender": "FEMALE",
"createdAt": "2021-02-18T04:01:07Z",
"updatedAt": "2023-07-07T05:10:55Z"
}
]
}

Career statistics for profile (Private)

The Career Stats API will return the profile's complete Career Stats record for a specified PlayHQ profile ID and role in a tenant(s).

path Parameters

required

string

ID of the profile

query Parameters

role	enum Enum: "PLAYER" "COACH" "TEAM_MANAGER" "ASSISTANT_COACH" "VOLUNTEER" "OFFICIAL" "MEDICAL_OFFICER" Participant role

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"totals": [{"count": 1,
"value": "APPEARANCE"
},
{"count": 1,
"value": "BEST_PLAYER"
},
{"count": 3,
"value": "GOAL_COUNT"
}
],
"clubStatistics": [{"club": {"id": "",
"name": ""
},
"statistics": [{"count": 1,
"value": "APPEARANCE"
},
{"count": 1,
"value": "BEST_PLAYER"
},
{"count": 3,
"value": "GOAL_COUNT"
}
]
}
]
}

Seasons with statistics for profile (Private)

The Season Stats API will return season information for those season in which a specified PlayHQ profile ID earned stats within a tenant.

path Parameters

required

string

ID of the profile

query Parameters

role	enum Enum: "PLAYER" "COACH" "TEAM_MANAGER" "ASSISTANT_COACH" "VOLUNTEER" "OFFICIAL" "MEDICAL_OFFICER" Participant role

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"seasons": [{"id": "24b76cc2-3b52-4372-9046-1e7182364167",
"name": "Winter 2024"
},
{"id": "24b76cc2-3b52-4372-9046-1e7182364169",
"name": "Summer 2024"
}
]
}

Season statistics for profile (Private)

The season stats API will return a profile's complete Season Stats record for a specified PlayHQ profile ID, seasonId and role in a tenant(s).

path Parameters

required

string

ID of the profile

query Parameters

role	enum Enum: "PLAYER" "COACH" "TEAM_MANAGER" "ASSISTANT_COACH" "VOLUNTEER" "OFFICIAL" "MEDICAL_OFFICER" Participant role

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"season": {"id": "62111ca8-58ab-430c-b588-1370a4248aec",
"name": "2023"
},
"role": "PLAYER",
"club": {"id": "62111ca8-58ab-430c-b588-1370a4248aea",
"name": "Club 2023"
},
"competition": {"id": "62111ca8-58ab-430c-b588-1370a4248aee",
"name": "Competition 2023"
},
"association": null,
"statistics": [{"count": 2,
"value": "APPEARANCE"
},
{"count": 0,
"value": "GOAL_COUNT"
}
],
"teamStatistics": [{"team": {"id": "62111ca8-58ab-430c-b588-1370a4248aee",
"name": "Team 2023"
},
"statistics": [{"count": 2,
"value": "APPEARANCE"
},
{"count": 0,
"value": "GOAL_COUNT"
}
],
"gradeStatistics": [{"grade": {"id": "62111ca8-58ab-430c-b588-1370a4248aee",
"name": "Grade 2023"
},
"statistics": [{"count": 2,
"value": "APPEARANCE"
},
{"count": 0,
"value": "GOAL_COUNT"
}
],
"gameStatistics": [{"game": {"id": "62111ca8-58ab-430c-b588-1370a4248aee",
"provisionalDates": ["2023-11-10"
],
"roundName": "Round 1",
"opposingTeamName": "Team 1"
},
"statistics": [{"count": 1,
"value": "APPEARANCE"
},
{"count": 0,
"value": "GOAL_COUNT"
}
]
},
{"game": {"id": "62111ca8-58ab-430c-b588-1370a4248aer",
"provisionalDates": ["2023-11-11"
],
"roundName": "Round 2",
"opposingTeamName": "Team 2"
},
"statistics": [{"count": 1,
"value": "APPEARANCE"
},
{"count": 0,
"value": "GOAL_COUNT"
}
]
}
]
}
]
}
]
}

Profile Updated Webhook

The following page outlines the triggers and data that will be included in the Profile webhook. Profiles will be sent to a tenant where they have registrations to the tenant or they have linked to the tenant’s external account.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROFILE.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "f804f035-4423-4fa0-b19e-60ff087c2544",
"entityType": "PROFILE",
"eventType": "PROFILE.UPDATED",
"entityId": "d00fa69c-60ad-435d-b5fe-3f3528d2edea",
"subscriberId": null,
"subscriberUrl": null,
"eventRaisedDateTime": "2022-04-12T23:22:25.681Z",
"headers": null,
"payload": {"messageId": "56451d03-9039-43b6-98d2-500898b35cd3",
"eventType": "PROFILE.UPDATED",
"entityId": "d00fa69c-60ad-435d-b5fe-3f3528d2edea",
"eventRaisedDateTime": "2022-04-12T23:22:25.681Z",
"data": {"id": "d00fa69c-60ad-435d-b5fe-3f3528d2edea",
"wwc": null,
"accountHolderProfileId": "0e3d609c-6f13-4bb0-b717-0964d9270172",
"externalAccountId": null,
"participant": {"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "2009-03-03T00:00:00.000Z",
"gender": "MALE",
"address": "628 Fabien Extension",
"suburb": "Vupv",
"postcode": 5609,
"state": "SA",
"country": "Australia",
"emailAddress": null,
"mobilePhone": null,
"mobileCountryCode": null
},
"profileVisible": true,
"parentGuardiansBornOverseas": "NO",
"parentGuardian1CountryOfBirth": null,
"parentGuardian2CountryOfBirth": null,
"hasDisability": "NO",
"disabilities": [ ],
"otherDisabilityDescription": null,
"additionalDisabilitySupportInformation": null,
"participantOrigin": "NO",
"parentGuardians": [{"firstName": "Jorge",
"lastName": "Doe",
"mobileNumber": 423360362,
"mobileCountryCode": 61,
"emailAddress": "jorgedoe@afa.com",
"address": "628 Fabien Extension",
"suburb": "Vupv",
"postcode": 5609,
"state": "SA",
"country": "Australia"
}
],
"emergencyContact": {"firstName": "J",
"lastName": "G",
"mobile": 446675598,
"mobileCountryCode": 61,
"emailAddress": "j@playhw.com",
"relationship": "mom"
},
"createdAt": "2021-02-18T04:23:54.000Z",
"updatedAt": "2022-02-02T04:56:39.000Z"
}
},
"payloadSignature": "034140e7ed594404ca8819ef3420fd32095e6aa60497f3e25249712dcdd9087b"
}

Profile Claimed Webhook

Information about an exisiting profile which has been archived as a result of a profile claim.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "PROFILE.CLAIMED"
	object

Responses

Request samples

Payload

Content type

application/json

{"data": {"claimedProfileId": "d5959494-abac-445a-a96e-1698d0fa888b",
"destinationProfileId": "329e50ea-47d2-4eed-8db9-d02c0e66925d",
"deleted": false
}
}

Admins

Admin Invited Webhook

The admin invited webhook captures information about when an admin is invited to a given organisation. A filter has been established so that a consumer can filter for specific admin role types. Please note, an admin profile can have a role at multiple organisations at any point in time.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "ADMIN.INVITED"
	object

Responses

Request samples

Payload

Content type

application/json

[{"messageId": "eed1b33c-14be-4e49-b051-698ea3123936",
"eventType": "ADMIN.INVITED",
"entityId": "0b2199fc-7c99-4287-aa15-2174069411bc",
"eventRaisedDateTime": "2023-06-20T06:14:09.060Z",
"data": {"id": "0b2199fc-7c99-4287-aa15-2174069411bc",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@mail.com",
"role": "SUPER_ADMIN",
"organisation": {"id": "1ed38a16-de48-4879-a6fd-2d7d6dc943e3",
"name": "Cricket Australia",
"type": "ADMINISTRATIVE_BODY"
}
}
}
]

Admin Revoked Webhook

The admin revoked webhook captures information about when an admin’s role is revoked for a given organisation. A filter has been established so that a consumer can filter for specific admin role types.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "ADMIN.REVOKED"
	object

Responses

Request samples

Payload

Content type

application/json

[{"messageId": "eed1b33c-14be-4e49-b051-698ea3123936",
"eventType": "ADMIN.REVOKED",
"entityId": "0b2199fc-7c99-4287-aa15-2174069411bc",
"eventRaisedDateTime": "2023-06-20T06:14:09.060Z",
"data": {"id": "0b2199fc-7c99-4287-aa15-2174069411bc",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@mail.com",
"role": "SUPER_ADMIN",
"organisation": {"id": "1ed38a16-de48-4879-a6fd-2d7d6dc943e3",
"name": "Cricket Australia",
"type": "ADMINISTRATIVE_BODY"
}
}
}
]

Venues

Lists all venues

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number >= 0 Default: 1 Page Number to fetch data - the maximum value of this parameter will be equal to the totalPages in response metadata
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type

application/json

{"data": {"venues": [{"id": "dc70a97b-064a-4e60-a19a-10757442aa87",
"name": "Melbourne Centre",
"abbreviatedName": "ABC",
"timezone": "Australia/Melbourne",
"createdAt": "2020-08-10T02:05:17.812000000Z",
"updatedAt": "2020-08-10T07:29:20.402000000Z",
"contact": {"name": "XYZ",
"phone": "+61-123456",
"website": "https://example.com"
},
"address": {"line1": "1 example street",
"suburb": "Fitzroy",
"postcode": "3000",
"state": "VIC",
"country": "Australia",
"latitude": "123456",
"longitude": "123456"
},
"playingSurfaces": [{"id": "8744d03a-8147-4987-afa5-ec2cbbe7de79",
"name": "Court 2",
"abbreviatedName": "Crt2",
"surfaceType": "WOODEN_SPRUNG"
}
]
}
]
},
"metadata": {"page": 4,
"totalPages": 36,
"totalRecords": 355
}
}

Orders

Order Created Webhook

The Order webhook captures information about orders created during registration. A filter has been established so that a consumer can filter for orders containing products to be delivered by a fulfilment provider.

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
	Array of objects For subscribers which have filters enabled, this array contains the ids of entities which passed those filters and allowed the entity to be dispatched.
eventType	string Value: "ORDER.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "e68b683a-63cd-4378-b678-38ebef1664b7",
"eventType": "ORDER.CREATED",
"entityId": "66bdd68e-f73c-11ea-adc1-0242ac129999",
"eventRaisedDateTime": "2023-01-01T12:00:00.001Z",
"data": {"id": "66bdd68e-f73c-11ea-adc1-0242ac129999",
"createdAt": "2022-04-29T00:55:23.948Z",
"customer": {"firstName": "John",
"lastName": "Doe",
"email": "test@email.com",
"phone": "+61 412345678"
},
"shippingAddress": {"address": "123 Str.",
"suburb": "Hillarys",
"state": "WA",
"postcode": "6025",
"country": "Australia"
},
"lineItems": [{"id": "9f7f5a82-f7bb-11ea-adc1-0242ac120002",
"productVariantId": "71bdd68e-f73c-11ea-adc1-0242ac120002",
"quantity": 2,
"customFieldAnswers": [{"id": "11bdd11e-f73c-11ea-adc1-0242ac121111",
"answer": "Tom"
}
]
}
],
"registration": {"participant": {"profileId": "58d9e86a-f73c-11ea-adc1-0242ac120002",
"firstName": "Jane",
"lastName": "Doe",
"role": "PLAYER"
},
"organisation": {"id": "89104616-f5a1-4f37-8e51-fa6e8adeaeb1",
"name": "St Kilda Club"
},
"activity": {"id": "43d9e86a-f73c-11ea-adc1-0942ac120556",
"name": "Cricket Blast",
"type": "SHARED_PROGRAM"
}
}
}
}

API Auth Token

Generate auth token

Provides a jwt token in an object to be used for all requests to the api

Request Body schema: application/json

A json object containing Client ID and Client Secret

clientId required	string
clientSecret required	string

Responses

Request samples

Payload

Content type

application/json

{"clientId": "YOUR_CLIENT_ID_HERE",
"clientSecret": "YOUR_CLIENT_SECRET_HERE"
}

Response samples

Content type

application/json

{"access_token": "ACCESS_TOKEN_HERE",
"exp": 1588214707
}

Game Payment Contract

Game payment contract for organisation

path Parameters

required

string

ID of the organisation

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Request Body schema: application/json

status

enum

Enum: "ACTIVE" "INACTIVE"

Status value to indicate if the game payment contract is active or inactive

Responses

Request samples

Payload

Content type

application/json

{"status": "ACTIVE"
}

Response samples

Content type

application/json

null