Recording data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model
FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
event_idstringNo(reference to CalendarEvent)
web_urlstringNo
mediaCalendarRecordingMedia[]No
media[].attendeesCalendarAttendee[]No
media[].attendees[].user_idstringNo(reference to HrisEmployee)
media[].attendees[].emailstringNo
media[].attendees[].namestringNo
media[].attendees[].statusenumNoValues: ACCEPTED, REJECTED, TENTATIVE
media[].attendees[].requiredbooleanNo
media[].attendees[].is_cohostbooleanNo
media[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].languagestringNotwo digit ISO code
media[].transcriptsCalendarRecordingTranscript[]No
media[].transcripts[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].transcripts[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].transcripts[].textstringYes
media[].transcripts[].attendeeCalendarRecordingTranscript_attendeeNo
media[].transcripts[].attendee.user_idstringNo(reference to HrisEmployee)
media[].transcripts[].attendee.emailstringNo
media[].transcripts[].attendee.namestringNo
media[].transcripts[].attendee.statusenumNoValues: ACCEPTED, REJECTED, TENTATIVE
media[].transcripts[].attendee.requiredbooleanNo
media[].transcripts[].attendee.is_cohostbooleanNo
media[].transcripts[].languagestringNotwo digit ISO code
media[].summarystringNoprovider AI-generated meeting summary
media[].transcript_download_urlstringNo
media[].summary_download_urlstringNodownload/export link for a provider AI summary document (e.g. Google Meet smart notes)
media[].recording_download_urlstringNo
metadataCalendarMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type CalendarRecording = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	expires_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	event_id?: string; // (reference to CalendarEvent)
	web_url?: string;
	media?: [];
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodCalendarRecording = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	expires_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	event_id: z.string().optional().describe("(reference to CalendarEvent)"),
	web_url: z.string().optional(),
	media: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CalendarRecording:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	expires_at: Optional[str]
	"""(reference to CalendarEvent)"""
	event_id: Optional[str]
	web_url: Optional[str]
	media: Optional[PropertyCalendarRecordingMedia]
	metadata: Optional[PropertyCalendarRecordingMetadata]
Are we missing anything? Let us know
Was this page helpful?