Comment 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)
textstringNoThe comment's text
user_idstringNo(reference to HrisEmployee)
user_namestringNo
task_idstringNo(reference to TaskTask)
parent_idstringNo
has_childrenbooleanNo
metadataTaskMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.

TypeScript

TypeScript
export type TaskComment = {
	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)
	text?: string; // The comment's text
	user_id?: string; // (reference to HrisEmployee)
	user_name?: string;
	task_id?: string; // (reference to TaskTask)
	parent_id?: string;
	has_children?: boolean;
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodTaskComment = 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)"),
	text: z.string().optional().describe("The comment's text"),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	user_name: z.string().optional(),
	task_id: z.string().optional().describe("(reference to TaskTask)"),
	parent_id: z.string().optional(),
	has_children: z.boolean().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class TaskComment:
	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 comment's text"""
	text: Optional[str]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	user_name: Optional[str]
	"""(reference to TaskTask)"""
	task_id: Optional[str]
	parent_id: Optional[str]
	has_children: Optional[bool]
	metadata: Optional[PropertyTaskCommentMetadata]
Are we missing anything? Let us know
Was this page helpful?