Playground

Playground

TimelineEvent

/api/v1/common/timeline-events

A source-backed business activity ledger event.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp 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-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
source_id*stringID of the source record (account, project, incident, etc.).
source_type*enumaccount | project | task | incident | approval | contract | lead | deal | case | policy | risk | asset | employee | meeting | document | otherType of source entity.
domain*enumwork | service | legal | marketing | finance | hr | compliance | operations | security | customer | otherBusiness domain this event belongs to.
event_type*enumcreated | updated | status_changed | assigned | comment_added | attachment_added | approval_requested | approved | rejected | escalated | resolved | closed | reopened | deadline_set | deadline_missed | milestone_reached | handoff | otherType of timeline event.
title*stringHuman-readable event title.
summarystringDetailed summary of what happened.
actor_idstringUser who performed the action (if human-initiated).
actor_typeenumuser | system | agent | workflow | externalType of actor.
actor_namestringDisplay name of the actor.
occurred_at*date-timeWhen the event occurred.
visibilityenumpublic | internal | private | restrictedWho can see this event.
risk_levelenumnone | low | medium | high | criticalRisk level associated with this event.
citation_refsjsonArray of source records that prove this event happened.
previous_statejsonState before the event (for change events).
current_statejsonState after the event (for change events).
metadatajsonAdditional context-specific data.
tagsjsonFree-form tags.

API

Loading manifest…