Review data model

Updated:

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

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)
user_idstringYesthe HR Employee being reviewed (reference to HrisEmployee)
reviewer_user_idstringNothe HR Employee that wrote this review (reference to HrisEmployee)
cycle_idstringNopointer to the Performance Cycle object
template_identifierstringNoid of the review template/form this review is based on
typeenumNoValues: SELF, MANAGER, PEER, UPWARD, OTHER
statusenumNoValues: DRAFT, IN_PROGRESS, SUBMITTED, COMPLETED, SHARED, ACKNOWLEDGED, OTHER
ratingnumberNothe overall rating/score of this review
rating_maximumnumberNothe maximum possible rating/score on the provider's scale
rating_descriptionstringNolabel of the rating on the provider's scale (e.g. "Exceeds expectations")
commentstringNothe overall/summary comment of this review
questionsPerformanceReviewQuestion[]No
questions[].questionstringYes
questions[].descriptionstringNo
questions[].typeenumNoValues: TEXT, SINGLE_SELECT, MULTI_SELECT, RATING, OTHER
questions[].answersstring[]Noall answer values; single-answer questions have one element
is_acknowledgedbooleanNowhether the reviewee acknowledged this review
submitted_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataPerformanceMetadata[]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 PerformanceReview = {
	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)
	user_id: string; // the HR Employee being reviewed (reference to HrisEmployee)
	reviewer_user_id?: string; // the HR Employee that wrote this review (reference to HrisEmployee)
	cycle_id?: string; // pointer to the Performance Cycle object
	template_identifier?: string; // id of the review template/form this review is based on
	type?: 'SELF' | 'MANAGER' | 'PEER' | 'UPWARD' | 'OTHER';
	status?: 'DRAFT' | 'IN_PROGRESS' | 'SUBMITTED' | 'COMPLETED' | 'SHARED' | 'ACKNOWLEDGED' | 'OTHER';
	rating?: number; // the overall rating/score of this review
	rating_maximum?: number; // the maximum possible rating/score on the provider's scale
	rating_description?: string; // label of the rating on the provider's scale (e.g. "Exceeds expectations")
	comment?: string; // the overall/summary comment of this review
	questions?: [];
	is_acknowledged?: boolean; // whether the reviewee acknowledged this review
	submitted_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	completed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodPerformanceReview = 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)"),
	user_id: z.string().describe("the HR Employee being reviewed (reference to HrisEmployee)"),
	reviewer_user_id: z.string().optional().describe("the HR Employee that wrote this review (reference to HrisEmployee)"),
	cycle_id: z.string().optional().describe("pointer to the Performance Cycle object"),
	template_identifier: z.string().optional().describe("id of the review template/form this review is based on"),
	type: z.enum("SELF", "MANAGER", "PEER", "UPWARD", "OTHER").optional(),
	status: z.enum("DRAFT", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "SHARED", "ACKNOWLEDGED", "OTHER").optional(),
	rating: z.number().optional().describe("the overall rating/score of this review"),
	rating_maximum: z.number().optional().describe("the maximum possible rating/score on the provider's scale"),
	rating_description: z.string().optional().describe("label of the rating on the provider's scale (e.g. "Exceeds expectations")"),
	comment: z.string().optional().describe("the overall/summary comment of this review"),
	questions: z.array().optional(),
	is_acknowledged: z.boolean().optional().describe("whether the reviewee acknowledged this review"),
	submitted_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	completed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PerformanceReviewType(str, Enum):
	SELF = 'SELF'
	MANAGER = 'MANAGER'
	PEER = 'PEER'
	UPWARD = 'UPWARD'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceReviewStatus(str, Enum):
	DRAFT = 'DRAFT'
	IN_PROGRESS = 'IN_PROGRESS'
	SUBMITTED = 'SUBMITTED'
	COMPLETED = 'COMPLETED'
	SHARED = 'SHARED'
	ACKNOWLEDGED = 'ACKNOWLEDGED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceReview:
	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]
	"""the HR Employee being reviewed (reference to HrisEmployee)"""
	user_id: str
	"""the HR Employee that wrote this review (reference to HrisEmployee)"""
	reviewer_user_id: Optional[str]
	"""pointer to the Performance Cycle object"""
	cycle_id: Optional[str]
	"""id of the review template/form this review is based on"""
	template_identifier: Optional[str]
	type: Optional[PerformanceReviewType]
	status: Optional[PerformanceReviewStatus]
	"""the overall rating/score of this review"""
	rating: Optional[int]
	"""the maximum possible rating/score on the provider's scale"""
	rating_maximum: Optional[int]
	"""label of the rating on the provider's scale (e.g. "Exceeds expectations")"""
	rating_description: Optional[str]
	"""the overall/summary comment of this review"""
	comment: Optional[str]
	questions: Optional[PropertyPerformanceReviewQuestions]
	"""whether the reviewee acknowledged this review"""
	is_acknowledged: Optional[bool]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	submitted_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	completed_at: Optional[str]
	metadata: Optional[PropertyPerformanceReviewMetadata]
Are we missing anything? Let us know
Was this page helpful?