Activity data model

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)
candidate_idstringNo
application_idstringNo
job_idstringNo
interview_idstringNo
document_idsstring[]NoIDs for AtsDocument.get
titlestringNo
descriptionstringNo
is_privatebooleanNo
user_idsstring[]Noid values of the recruiters associated with the activity.
typeenumNoValues: NOTE, TASK, EMAIL
fromobjectNo
from.namestringNo
from.emailstringNo
from.typeenumNoValues: WORK, HOME, OTHER
toAtsEmail[]No
to[].namestringNo
to[].emailstringYes
to[].typeenumNoValues: WORK, HOME, OTHER
ccAtsEmail[]No
cc[].namestringNo
cc[].emailstringYes
cc[].typeenumNoValues: WORK, HOME, OTHER
bccAtsEmail[]No
bcc[].namestringNo
bcc[].emailstringYes
bcc[].typeenumNoValues: WORK, HOME, OTHER
sub_typestringNo
company_idstringNo(reference to AtsCompany)
metadataAtsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNoActual textual value of the slug
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 AtsActivity = {
	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)
	candidate_id?: string;
	application_id?: string;
	job_id?: string;
	interview_id?: string;
	document_ids?: string[]; // IDs for AtsDocument.get
	title?: string;
	description?: string;
	is_private?: boolean;
	user_ids?: string[]; // id values of the recruiters associated with the activity.
	type?: 'NOTE' | 'TASK' | 'EMAIL';
	from?: {
		name?: string; 
		email?: string; 
		type?: 'WORK' | 'HOME' | 'OTHER'; 
	};
	to?: [];
	cc?: [];
	bcc?: [];
	sub_type?: string;
	company_id?: string; // (reference to AtsCompany)
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAtsActivity = 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)"),
	candidate_id: z.string().optional(),
	application_id: z.string().optional(),
	job_id: z.string().optional(),
	interview_id: z.string().optional(),
	document_ids: z.array().optional().describe("IDs for AtsDocument.get"),
	title: z.string().optional(),
	description: z.string().optional(),
	is_private: z.boolean().optional(),
	user_ids: z.array().optional().describe("id values of the recruiters associated with the activity."),
	type: z.enum("NOTE", "TASK", "EMAIL").optional(),
	from: z.object({
			name: z.string().optional(),
			email: z.string().optional(),
			type: z.enum("WORK", "HOME", "OTHER").optional()
}).optional(),
	to: z.array().optional(),
	cc: z.array().optional(),
	bcc: z.array().optional(),
	sub_type: z.string().optional(),
	company_id: z.string().optional().describe("(reference to AtsCompany)"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AtsActivityType(str, Enum):
	NOTE = 'NOTE'
	TASK = 'TASK'
	EMAIL = 'EMAIL'

@dataclasses.dataclass
class AtsActivityFromType(str, Enum):
	WORK = 'WORK'
	HOME = 'HOME'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PropertyAtsActivityFrom:
	name: Optional[str]
	email: Optional[str]
	type: Optional[AtsActivityFromType]

@dataclasses.dataclass
class AtsActivity:
	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]
	candidate_id: Optional[str]
	application_id: Optional[str]
	job_id: Optional[str]
	interview_id: Optional[str]
	"""IDs for AtsDocument.get"""
	document_ids: Optional[List[List[str]]]
	title: Optional[str]
	description: Optional[str]
	is_private: Optional[bool]
	"""id values of the recruiters associated with the activity."""
	user_ids: Optional[List[List[str]]]
	type: Optional[AtsActivityType]
	from: Optional[PropertyAtsActivityFrom]
	to: Optional[PropertyAtsActivityTo]
	cc: Optional[PropertyAtsActivityCc]
	bcc: Optional[PropertyAtsActivityBcc]
	sub_type: Optional[str]
	"""(reference to AtsCompany)"""
	company_id: Optional[str]
	metadata: Optional[PropertyAtsActivityMetadata]
Are we missing anything? Let us know
Was this page helpful?