Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.fact0.io/llms.txt

Use this file to discover all available pages before exploring further.

Audit event schema

Every client.audit.log() call validates against this shape before enqueue.

Top-level fields

FieldTypeRequiredNotes
actorobjectyesWho performed the action
actionstringyesDot-notation: resource.verb
resourceobjectyesTarget of the action
outcomeenumyessuccess | failure | error
metadataobjectnoArbitrary JSON context
idstringnoClient UUID for idempotency; server assigns if omitted
timestampdatetimenoISO 8601 UTC; defaults to now
Server-set fields on committed events: tenant_id, prev_hash, hash, sequence_number.

Actor

{"id": "user_123", "type": "human", "email": "admin@acme.com"}
type: human | agent | system

Resource

{"id": "doc_456", "type": "document", "name": "Q3 Report"}
Use stable resource.id values you can filter on later.

Outcome semantics

ValueMeaning
successAction completed as intended
failureExpected business failure (permission denied, invalid input)
errorUnexpected system error (timeout, exception)

Common actions

user.login  user.logout  document.delete  agent.run.start
agent.tool.call  config.update  api_key.revoke  audit.export