Audit Event
A single audit event recording who changed what, when, and why. Designed for enterprise audit trail requirements, probate court compliance, and GDPR-compatible personal data handling
A single audit event recording who changed what, when, and why. Designed for enterprise audit trail requirements, probate court compliance, and GDPR-compatible personal data handling
Required fields
actionperformedAt
Fields
| Field | Type | Req | Description |
|---|---|---|---|
| action | enum | What type of action was performed created: entity or document was created. modified: entity was changed. deleted: entity was removed. accessed: entity was read (for access logging). exported: document was exported. validated: document was validated. version_created: a new document version was created. | |
| agentDescription | string | Human-readable description of who performed the action. Use only when a person ID is not available (e.g. system actions, external agents) | |
| agentPersonId | string | Reference to the Person.id who performed the action. Uses a UUID reference rather than a display name for GDPR data minimisation — resolve the name at display time, not storage time | |
| detail | string | What specifically was done. Should be specific enough for an auditor to understand without seeing the before/after data | |
| entityId | string | The ID of the entity that was affected | |
| entityType | string | The type of INHERIT entity that was affected | |
| evidenceUrl | string | Link to supporting evidence (court order, signed document, etc.) | |
| newValue | string | The value after the change, if applicable | |
| performedAt | string | When the action occurred | |
| previousValue | string | The value before the change, if applicable. For field-level audit trails | |
| redacted | boolean | Whether this audit entry has been redacted for GDPR compliance. When true, the agentPersonId and detail fields may have been cleared but the structural record of the action is preserved |
Before you get in touch
These resources may answer your question straight away.
Get in touch
Have feedback on the schema reference? We'd love to hear from you.
Subject: Schema Reference Feedback