Notification data model

Updated:

A notification of an event that occurred in you account.

FieldTypeRequiredDescription
idstringNoUnique identifier for this notification object (read-only)
created_atstring (date-time)NoThe date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstringNo(reference to KmsSpace) (read-only)
descriptionstringNoLonger description of this notification
user_idstringNo(reference to HrisEmployee)
user_namestringNo
workspace_namestringNo
webhook_idstringNo
connection_idstringNo
integration_typestringNo
integration_namestringNo
sent_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
eventenumNoValues: USER_CREATED, USER_DELETED, CONNECTION_HEALTHY, CONNECTION_UNHEALTHY, CONNECTION_CREATED, CONNECTION_UPDATED, CONNECTION_DELETED, CONNECTION_PAUSED, CONNECTION_UNPAUSED, INTEGRATION_ACTIVATED, INTEGRATION_DEACTIVATED, INTEGRATION_UPDATED, WORKSPACE_UPDATED, WORKSPACE_OVER_LIMIT, WORKSPACE_80PERCENT_LIMIT, WEBHOOK_CREATED, WEBHOOK_DELETED, WEBHOOK_UNHEALTHY, WEBHOOK_PAUSED, WEBHOOK_UNPAUSED

TypeScript

TypeScript
export type Notification = {
	id?: string; // Unique identifier for this notification object
	created_at?: string-time; // The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	workspace_id?: string; // (reference to KmsSpace)
	description?: string; // Longer description of this notification
	user_id?: string; // (reference to HrisEmployee)
	user_name?: string;
	workspace_name?: string;
	webhook_id?: string;
	connection_id?: string;
	integration_type?: string;
	integration_name?: string;
	sent_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	event?: 'USER_CREATED' | 'USER_DELETED' | 'CONNECTION_HEALTHY' | 'CONNECTION_UNHEALTHY' | 'CONNECTION_CREATED' | 'CONNECTION_UPDATED' | 'CONNECTION_DELETED' | 'CONNECTION_PAUSED' | 'CONNECTION_UNPAUSED' | 'INTEGRATION_ACTIVATED' | 'INTEGRATION_DEACTIVATED' | 'INTEGRATION_UPDATED' | 'WORKSPACE_UPDATED' | 'WORKSPACE_OVER_LIMIT' | 'WORKSPACE_80PERCENT_LIMIT' | 'WEBHOOK_CREATED' | 'WEBHOOK_DELETED' | 'WEBHOOK_UNHEALTHY' | 'WEBHOOK_PAUSED' | 'WEBHOOK_UNPAUSED';
} 

Zod

Zod
import { z } from 'zod';

export const ZodNotification = z.object({
	id: z.string().optional().describe("Unique identifier for this notification object"),
	created_at: z.string-time().optional().describe("The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	workspace_id: z.string().optional().describe("(reference to KmsSpace)"),
	description: z.string().optional().describe("Longer description of this notification"),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	user_name: z.string().optional(),
	workspace_name: z.string().optional(),
	webhook_id: z.string().optional(),
	connection_id: z.string().optional(),
	integration_type: z.string().optional(),
	integration_name: z.string().optional(),
	sent_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	event: z.enum("USER_CREATED", "USER_DELETED", "CONNECTION_HEALTHY", "CONNECTION_UNHEALTHY", "CONNECTION_CREATED", "CONNECTION_UPDATED", "CONNECTION_DELETED", "CONNECTION_PAUSED", "CONNECTION_UNPAUSED", "INTEGRATION_ACTIVATED", "INTEGRATION_DEACTIVATED", "INTEGRATION_UPDATED", "WORKSPACE_UPDATED", "WORKSPACE_OVER_LIMIT", "WORKSPACE_80PERCENT_LIMIT", "WEBHOOK_CREATED", "WEBHOOK_DELETED", "WEBHOOK_UNHEALTHY", "WEBHOOK_PAUSED", "WEBHOOK_UNPAUSED").optional()
});

Python

Python
import dataclasses

@dataclasses.dataclass
class NotificationEvent(str, Enum):
	USER_CREATED = 'USER_CREATED'
	USER_DELETED = 'USER_DELETED'
	CONNECTION_HEALTHY = 'CONNECTION_HEALTHY'
	CONNECTION_UNHEALTHY = 'CONNECTION_UNHEALTHY'
	CONNECTION_CREATED = 'CONNECTION_CREATED'
	CONNECTION_UPDATED = 'CONNECTION_UPDATED'
	CONNECTION_DELETED = 'CONNECTION_DELETED'
	CONNECTION_PAUSED = 'CONNECTION_PAUSED'
	CONNECTION_UNPAUSED = 'CONNECTION_UNPAUSED'
	INTEGRATION_ACTIVATED = 'INTEGRATION_ACTIVATED'
	INTEGRATION_DEACTIVATED = 'INTEGRATION_DEACTIVATED'
	INTEGRATION_UPDATED = 'INTEGRATION_UPDATED'
	WORKSPACE_UPDATED = 'WORKSPACE_UPDATED'
	WORKSPACE_OVER_LIMIT = 'WORKSPACE_OVER_LIMIT'
	WORKSPACE_80PERCENT_LIMIT = 'WORKSPACE_80PERCENT_LIMIT'
	WEBHOOK_CREATED = 'WEBHOOK_CREATED'
	WEBHOOK_DELETED = 'WEBHOOK_DELETED'
	WEBHOOK_UNHEALTHY = 'WEBHOOK_UNHEALTHY'
	WEBHOOK_PAUSED = 'WEBHOOK_PAUSED'
	WEBHOOK_UNPAUSED = 'WEBHOOK_UNPAUSED'

@dataclasses.dataclass
class Notification:
	"""Unique identifier for this notification object"""
	id: Optional[str]
	"""The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(reference to KmsSpace)"""
	workspace_id: Optional[str]
	"""Longer description of this notification"""
	description: Optional[str]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	user_name: Optional[str]
	workspace_name: Optional[str]
	webhook_id: Optional[str]
	connection_id: Optional[str]
	integration_type: Optional[str]
	integration_name: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	sent_at: Optional[str]
	event: Optional[NotificationEvent]
Are we missing anything? Let us know
Was this page helpful?