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.

FieldTypeRequiredDescription
idstringNoUnique identifier for this event
created_atstring (date-time)NoThe date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
group_idstringNoThe group this event belongs to (reference to HrisGroup)
namestringNoThe event name (or a "Home vs Away" matchup label)
descriptionstringNoA description or notes for the event
typeenumNoThe event type Values: GAME, PRACTICE, OTHER
statusenumNoThe event status Values: SCHEDULED, CANCELED, TBD, FINAL
start_atstring (date-time)NoWhen the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)NoWhen the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
timezonestringNoThe timezone of the event
duration_minutesnumberNoThe scheduled duration, in minutes
location_idstringNoThe id of the location for this event (reference to ClubsLocation)
location_namestringNoThe name of the location for this event
opponent_idstringNoThe id of the opposing team (single-opponent providers)
opponent_namestringNoThe name of the opposing team
home_team_namestringNoThe home team's name (homeaway providers)
away_team_namestringNoThe away team's name (homeaway providers)
home_scorenumberNoThe home team's score
away_scorenumberNoThe away team's score
score_fornumberNoThe connected groupteam's score (team-vs-opponent providers)
score_againstnumberNoThe opponent's score (team-vs-opponent providers)
is_homebooleanNoWhether the connected groupteam is the home side
urlstringNoA URL to the event

TypeScript

TypeScript
export type ClubsEvent = {
	id?: string; // Unique identifier for this event
	created_at?: string-time; // The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	group_id?: string; // The group this event belongs to (reference to HrisGroup)
	name?: string; // The event name (or a "Home vs Away" matchup label)
	description?: string; // A description or notes for the event
	type?: 'GAME' | 'PRACTICE' | 'OTHER'; // The event type
	status?: 'SCHEDULED' | 'CANCELED' | 'TBD' | 'FINAL'; // The event status
	start_at?: string-time; // When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	timezone?: string; // The timezone of the event
	duration_minutes?: number; // The scheduled duration, in minutes
	location_id?: string; // The id of the location for this event (reference to ClubsLocation)
	location_name?: string; // The name of the location for this event
	opponent_id?: string; // The id of the opposing team (single-opponent providers)
	opponent_name?: string; // The name of the opposing team
	home_team_name?: string; // The home team's name (homeaway providers)
	away_team_name?: string; // The away team's name (homeaway providers)
	home_score?: number; // The home team's score
	away_score?: number; // The away team's score
	score_for?: number; // The connected groupteam's score (team-vs-opponent providers)
	score_against?: number; // The opponent's score (team-vs-opponent providers)
	is_home?: boolean; // Whether the connected groupteam is the home side
	url?: string; // A URL to the event
	raw?: any; // The raw data returned by the integration for this event
} 

Zod

Zod
import { z } from 'zod';

export const ZodClubsEvent = z.object({
	id: z.string().optional().describe("Unique identifier for this event"),
	created_at: z.string-time().optional().describe("The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	group_id: z.string().optional().describe("The group this event belongs to (reference to HrisGroup)"),
	name: z.string().optional().describe("The event name (or a "Home vs Away" matchup label)"),
	description: z.string().optional().describe("A description or notes for the event"),
	type: z.enum("GAME", "PRACTICE", "OTHER").optional().describe("The event type"),
	status: z.enum("SCHEDULED", "CANCELED", "TBD", "FINAL").optional().describe("The event status"),
	start_at: z.string-time().optional().describe("When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	timezone: z.string().optional().describe("The timezone of the event"),
	duration_minutes: z.number().optional().describe("The scheduled duration, in minutes"),
	location_id: z.string().optional().describe("The id of the location for this event (reference to ClubsLocation)"),
	location_name: z.string().optional().describe("The name of the location for this event"),
	opponent_id: z.string().optional().describe("The id of the opposing team (single-opponent providers)"),
	opponent_name: z.string().optional().describe("The name of the opposing team"),
	home_team_name: z.string().optional().describe("The home team's name (homeaway providers)"),
	away_team_name: z.string().optional().describe("The away team's name (homeaway providers)"),
	home_score: z.number().optional().describe("The home team's score"),
	away_score: z.number().optional().describe("The away team's score"),
	score_for: z.number().optional().describe("The connected groupteam's score (team-vs-opponent providers)"),
	score_against: z.number().optional().describe("The opponent's score (team-vs-opponent providers)"),
	is_home: z.boolean().optional().describe("Whether the connected groupteam is the home side"),
	url: z.string().optional().describe("A URL to the event"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class ClubsEventType(str, Enum):
	GAME = 'GAME'
	PRACTICE = 'PRACTICE'
	OTHER = 'OTHER'

@dataclasses.dataclass
class ClubsEventStatus(str, Enum):
	SCHEDULED = 'SCHEDULED'
	CANCELED = 'CANCELED'
	TBD = 'TBD'
	FINAL = 'FINAL'

@dataclasses.dataclass
class ClubsEvent:
	"""Unique identifier for this event"""
	id: Optional[str]
	"""The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The group this event belongs to (reference to HrisGroup)"""
	group_id: Optional[str]
	"""The event name (or a "Home vs Away" matchup label)"""
	name: Optional[str]
	"""A description or notes for the event"""
	description: Optional[str]
	"""The event type"""
	type: Optional[ClubsEventType]
	"""The event status"""
	status: Optional[ClubsEventStatus]
	"""When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""The timezone of the event"""
	timezone: Optional[str]
	"""The scheduled duration, in minutes"""
	duration_minutes: Optional[int]
	"""The id of the location for this event (reference to ClubsLocation)"""
	location_id: Optional[str]
	"""The name of the location for this event"""
	location_name: Optional[str]
	"""The id of the opposing team (single-opponent providers)"""
	opponent_id: Optional[str]
	"""The name of the opposing team"""
	opponent_name: Optional[str]
	"""The home team's name (homeaway providers)"""
	home_team_name: Optional[str]
	"""The away team's name (homeaway providers)"""
	away_team_name: Optional[str]
	"""The home team's score"""
	home_score: Optional[int]
	"""The away team's score"""
	away_score: Optional[int]
	"""The connected groupteam's score (team-vs-opponent providers)"""
	score_for: Optional[int]
	"""The opponent's score (team-vs-opponent providers)"""
	score_against: Optional[int]
	"""Whether the connected groupteam is the home side"""
	is_home: Optional[bool]
	"""A URL to the event"""
	url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?