Feedback 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 that this feedback is about (reference to HrisEmployee)
author_user_idstringNothe HR Employee that gave this feedback (reference to HrisEmployee)
typeenumNopraise/recognition, constructive feedback, or a response to a feedback request Values: PRAISE, FEEDBACK, REQUESTED, OTHER
messagestringNo
tagsstring[]Nobadges or company values attached to this feedback
is_visiblebooleanNotrue when publicly visible (e.g. praise wall); false when private or manager-only
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 PerformanceFeedback = {
	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 that this feedback is about (reference to HrisEmployee)
	author_user_id?: string; // the HR Employee that gave this feedback (reference to HrisEmployee)
	type?: 'PRAISE' | 'FEEDBACK' | 'REQUESTED' | 'OTHER'; // praise/recognition, constructive feedback, or a response to a feedback request
	message?: string;
	tags?: string[]; // badges or company values attached to this feedback
	is_visible?: boolean; // true when publicly visible (e.g. praise wall); false when private or manager-only
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodPerformanceFeedback = 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 that this feedback is about (reference to HrisEmployee)"),
	author_user_id: z.string().optional().describe("the HR Employee that gave this feedback (reference to HrisEmployee)"),
	type: z.enum("PRAISE", "FEEDBACK", "REQUESTED", "OTHER").optional().describe("praise/recognition, constructive feedback, or a response to a feedback request"),
	message: z.string().optional(),
	tags: z.array().optional().describe("badges or company values attached to this feedback"),
	is_visible: z.boolean().optional().describe("true when publicly visible (e.g. praise wall); false when private or manager-only"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PerformanceFeedbackType(str, Enum):
	PRAISE = 'PRAISE'
	FEEDBACK = 'FEEDBACK'
	REQUESTED = 'REQUESTED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceFeedback:
	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 that this feedback is about (reference to HrisEmployee)"""
	user_id: str
	"""the HR Employee that gave this feedback (reference to HrisEmployee)"""
	author_user_id: Optional[str]
	"""praise/recognition, constructive feedback, or a response to a feedback request"""
	type: Optional[PerformanceFeedbackType]
	message: Optional[str]
	"""badges or company values attached to this feedback"""
	tags: Optional[List[List[str]]]
	"""true when publicly visible (e.g. praise wall); false when private or manager-only"""
	is_visible: Optional[bool]
	metadata: Optional[PropertyPerformanceFeedbackMetadata]
Are we missing anything? Let us know
Was this page helpful?