Skip to main content

Documentation Index

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

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

Audit log entries record state changes and actions on schedules, versions, and series. Every significant lifecycle event is captured with before/after state snapshots and request context.

Event types

Event typeTrigger
schedule.createdA new schedule is created via POST /schedules
version.submittedA schedule version is sent to the TSO
version.acceptedTSO ACK or CNF confirms acceptance
version.rejectedTSO rejects the submission
version.status_changedAny status transition on a version
series.status_changedPer-series status update from a partial CNF
anomaly.receivedAn ANO message is received from the TSO
status_request.sentA manual status request is triggered

Data structure

The data field is a combined object containing:
  • before — state snapshot before the event (when applicable)
  • after — state snapshot after the event
  • metadata — additional context (e.g. TSO response codes)
  • request_id — correlation ID for the triggering API request

Timestamp precision

The created_ts field includes millisecond precision (YYYY-MM-DDTHH:mm:ss.sssZ) to allow precise ordering of events that occur in rapid succession.

An audit log entry recording a state change or action on a schedule or series.

created_ts
string
required

ISO 8601 datetime with millisecond precision (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:

"2026-03-25T14:00:00.123Z"

data
Data · object
required

Combined metadata, before/after state snapshots, and request context.

type
string
required

Event type identifier (e.g. schedule.created, version.submitted, version.accepted).

Examples:

"schedule.created"

"version.submitted"

"version.accepted"

uid
string
required

Unique identifier for this audit event.

Example:

"e2f3a4b5-c6d7-4e8f-9a0b-1c2d3e4f5a6b"

api_client_id
string | null

API client identifier that triggered the event, if applicable.

org_uid
string | null

Organization identifier, if applicable.

schedule_uid
string | null

Related Schedule identifier, if applicable.

schedule_version_uid
string | null

Related Schedule Version identifier, if applicable.

time_series_uid
string | null

Related time series identifier, if applicable.

user_uid
string | null

Identifier of the user who triggered the event, if applicable.

version
integer
default:1

Event schema version.

Example:

1