The following changes are scheduled to be released by PlayHQ on the 15th of May 2023.
The Program Season Groups webhook is updated to allow for a start date and end date to be captured against each one of the selected session days.
Updated events:
- Created (PROGRAM_SEASON_GROUP.CREATED)
- Updated (PROGRAM_SEASON_GROUP.UPDATED
The Program Season Groups webhook is updated as per the table below:
- Fields highlighted in red will be deprecated over time, but will be kept in the webhook for now to support existing groups (for new or updated groups these fields will be empty)
Fields highlighted in green are added to the webhook
| Field Name | Field Label | Field Description | Type | Nullable | Comments |
| id | Group Id | PlayHQ’s unique Id for the Group within a Program Season | UUID | No | |
| organisationId | Organisation Id | Organisation that owns the group - even if it is a shared program | UUID | No | |
| programId | Program Id | Program Id that group belongs to (via season) | UUID | No | |
| seasonId | Season Id | Season Id that group belongs to | UUID | No | |
| name | Group name | Name of the Group | String (limited to 60 characters) | No | |
| days | Days | Array of the 7 days of the week that can be selected when creating / editing a group. Informs the days of the week that the group runs | String | Yes | Only selected days will appear in the array. Any days not selected will not appear. |
| sessionCount | Sessions | Number of sessions that will be run in group | Integer | Yes | |
| gender | Gender | Gender of group | String (no limited but defined picklist) | Yes | |
| startDate | Start date | Start date of group | Date | Yes | This date is presented as a string and will be provided in the tenant’s timezone |
| startTime | Start time | Start time of group | Time | Yes | |
| endTime | End time | End time of group | Time | Yes | |
| visible | Group visibility | Determines whether or not group is visible on registration form | Boolean | No | |
| venueId | Venue ID | Venue that the group takes place at | UUID | Yes | |
| venueName | Venue Name | Venue name associated with the venue ID | String (limited to 100 characters) | Yes | |
| venueLatitude | Venue Latitude | Venue latitude associated with the venue ID | String (no limit) | Yes | |
| venueLongitude | Venue Longitude | Venue longitude associated with the venue ID | String (no limit) | Yes | |
| playingSurfaceId | Playing Surface ID | Playing Surface at Venue that the group takes place at | UUID | Yes | |
| playingSurfaceName | Playing Surface Name | Playing Surface name associated with the venue ID | String (limited to 50 characters) | Yes | |
| playingSurfaceLatitude | Playing Surface Latitude | Playing Surface latitude associated with the venue ID | String (no limit) | Yes | |
| playingSurfaceLongitude | Playing Surface Longitude | Playing Surface longitude associated with the venue ID | String (no limit) | Yes | |
| daySessions | Days and Times |
Array of the 7 days of the week that can be selected when creating / editing a group, with a start and end session times for each day. Informs the days of the week that the group runs, and the session times |
Object Array | Yes | Replaces the days array, and the single startTime and endTime fields |
| daySessions.day | Day of Week | A day of week which has a session | String | Yes | |
| daySessions.startTime | Start time | Start time of the group session | Time | Yes | |
| daySessions.endTime | End time | End time of group session | Time | Yes |
Sample Response
