---
title: "TrailEvent"
description: "A Trails event, as recorded, plus `region`."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Trails API

A Trails event, as recorded, plus `region`.

## Fields

- `TrailEvent.eventCategory` (string, required)
- `TrailEvent.eventId` (string, required)
  - format `uuid`
- `TrailEvent.eventName` (string, required) — The operation: CreateWidget, LookupEvents.
- `TrailEvent.eventSource` (string, required) — `<namespace>.ezghcloud.com`.
- `TrailEvent.eventTime` (string, required)
  - format `date-time`
- `TrailEvent.eventType` (string, required) — ApiCall, ServiceEvent or SignIn.
- `TrailEvent.eventVersion` (string, required) — "1.0".
- `TrailEvent.organizationId` (string, required)
  - format `uuid`
- `TrailEvent.readOnly` (boolean, required)
- `TrailEvent.region` (string, required)
- `TrailEvent.resources` (array<object>, required)
  - `TrailEvent.resources.resourceName` (string, required)
  - `TrailEvent.resources.type` (string, required) — Organization, Project, Widget…
- `TrailEvent.userIdentity` (object, required) — Who made the call.
  - `TrailEvent.userIdentity.isRoot` (boolean, required)
  - `TrailEvent.userIdentity.accessKeyId` (string | null, optional)
  - `TrailEvent.userIdentity.invokedBy` (string | null, optional) — A service event's cause: the public namespace that made the change.
  - `TrailEvent.userIdentity.principalId` (string | null, optional)
  - `TrailEvent.userIdentity.sessionContext` (one of, optional)
    - one of: [SessionContext](/trails-api/schemas/SessionContext/), `null`
  - `TrailEvent.userIdentity.type` (string | null, optional) — User, Bot, Root or EzghService.
  - `TrailEvent.userIdentity.userName` (string | null, optional)
- `TrailEvent.additionalEventData` (object | null, optional)
- `TrailEvent.errorCode` (string | null, optional)
- `TrailEvent.errorMessage` (string | null, optional)
- `TrailEvent.projectId` (string | null, optional)
- `TrailEvent.requestId` (string | null, optional)
- `TrailEvent.requestParameters` (object | null, optional) — Path and query parameters and the body's top-level fields, secrets hidden.
- `TrailEvent.responseElements` (object | null, optional) — A successful write's identifiers.
- `TrailEvent.sourceIpAddress` (string | null, optional)
- `TrailEvent.userAgent` (string | null, optional)


Source: https://docs.ezghcloud.com/trails-api/schemas/TrailEvent/index.md