Skip to content
This documentation is currently in preview, therefore subject to change.

Audit Log Schema

This page documents the schema for audit log entries in the Build a Doc portal.


Log Entry Structure

FieldTypeDescription
timestampDateTimeWhen the event occurred (UTC)
eventTypeStringType of event
userIdStringUser who performed the action
userEmailStringUser’s email address
resourceTypeStringType of resource affected
actionStringSpecific action performed
detailsObjectAdditional event details
ipStringIP address of the actor (IPv4/IPv6)
severityStringSeverity level (Info, Warning, Error)

Event Types

Event TypeDescription
Api Key CreatedNew API key generated
Api Key RevokedAPI key deactivated
User InvitedNew user invited
User RemovedUser access removed
Role ChangedUser role modified
Subscription ChangedPlan modification