Event data model
(home-vs-away competitors with scores). Distinct from the fitness-oriented IClubsActivity.
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this event |
created_at | string (date-time) | No | The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
group_id | string | No | The group this event belongs to (reference to HrisGroup) |
name | string | No | The event name (or a "Home vs Away" matchup label) |
description | string | No | A description or notes for the event |
type | enum | No | The event type Values: GAME, PRACTICE, OTHER |
status | enum | No | The event status Values: SCHEDULED, CANCELED, TBD, FINAL |
start_at | string (date-time) | No | When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
timezone | string | No | The timezone of the event |
duration_minutes | number | No | The scheduled duration, in minutes |
location_id | string | No | The id of the location for this event (reference to ClubsLocation) |
location_name | string | No | The name of the location for this event |
opponent_id | string | No | The id of the opposing team (single-opponent providers) |
opponent_name | string | No | The name of the opposing team |
home_team_name | string | No | The home team's name (homeaway providers) |
away_team_name | string | No | The away team's name (homeaway providers) |
home_score | number | No | The home team's score |
away_score | number | No | The away team's score |
score_for | number | No | The connected groupteam's score (team-vs-opponent providers) |
score_against | number | No | The opponent's score (team-vs-opponent providers) |
is_home | boolean | No | Whether the connected groupteam is the home side |
url | string | No | A URL to the event |
Are we missing anything? Let us know