Comment data model

Updated:

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

FieldTypeRequiredDescription
idstringNo
created_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contentstringNo
user_idstringNoreference to HrisEmployee (reference to HrisEmployee)
call_idstringNo
metadataUcMetadata[]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 UcComment = {
	id?: string;
	created_at?: string; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	content?: string;
	user_id?: string; // reference to HrisEmployee (reference to HrisEmployee)
	call_id?: string;
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodUcComment = z.object({
	id: z.string().optional(),
	created_at: z.string().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	content: z.string().optional(),
	user_id: z.string().optional().describe("reference to HrisEmployee (reference to HrisEmployee)"),
	call_id: z.string().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class UcComment:
	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]
	content: Optional[str]
	"""reference to HrisEmployee (reference to HrisEmployee)"""
	user_id: Optional[str]
	call_id: Optional[str]
	metadata: Optional[PropertyUcCommentMetadata]
Are we missing anything? Let us know
Was this page helpful?