Notification

/api/v1/notifications/notifications

A targeted notification to a Person.

listgetmark_readdelete

Schema

Field	Type	Notes
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	`frontend \| backend \| server \| system \| api`Where the write originated. Defaults to 'api'.
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
recipient_id	uuid	UUID of the Person who should receive this notification.
type	string	Severity / intent classification of the notification.
channel	string	Delivery channel used for this notification.
title	string	Short summary line shown in notification lists and email subjects.
body	string	Full notification body text.
entity_type	string	The EDM entity type that triggered this notification (e.g. 'LeaveRequest', 'Contract').
entity_id	uuid	UUID of the triggering entity instance. Null when not tied to a specific record.
read_at	date-time	ISO 8601 timestamp when the recipient marked this notification as read. Null if still unread.
action_url	string	Optional deep-link URL the recipient can follow to act on this notification.

API

client.notifications.notifications.*

Loading manifest…

Playground

Notification

Schema