Stax Events - Event Schemas
Stax Events - Event Schemas
Article Tags
On This Page
Top-level propertiesDetail ObjectSee alsoStax Events follow a defined schema. This allows for event content to be predictable and consistent.
Review category pages to see schemas for specific events:
Top-level properties
All Stax events contain the following top-level properties:
Property | Type | Description |
---|---|---|
version | string | AWS event version |
id | integer | Event ID generated by Amazon EventBridge |
detail-type | string | Describes the source and event type |
source | string | Stax partner event source |
account | integer | AWS account ID |
time | date | The timestamp of the event |
region | string | Source AWS region |
resources | string | none |
detail | object | Stax specific payload. See Detail object below |
Detail Object
In addition to top-level properties, each Stax event can contain the following common properties in the detail object:
Property | Type | Required | Description |
---|---|---|---|
» meta | object | true | none |
»» customer | object | true | Customer attributes |
»»» id | string | true | Stax customer ID |
»»» name | string | false | Stax customer name |
»» organization | object | true | Organization attributes |
»»» id | string | true | Stax organization ID |
»»» name | string | false | Stax organization name |
»»» alias | string | false | Stax organization alias |
»» user | object | false | user attributes |
»»» id | string | true | Stax user ID |
»»» username | string | false | Stax username (Note: deprecated, will be removed in the future. See Email property) |
string | false | Stax user email | |
»» aws | object | false | aws attributes |
»»» accountId | string | true | AWS account ID of account where event was triggered |
»»» accountName | string | false | AWS account name of account where event was triggered |
»»» region | string | false | AWS region of account where event was triggered |
» staxEventVersion | string | true | Stax event version |
» staxEventID | string | true | Unique event ID |
» staxEventTime | string(date-time) | true | The timestamp of the event. Should be set by the publisher of the event - not the transport timestamp |
» staxEventSource | string | true | Stax component name that publishes the event. e.g., stax.networking, stax.auth |
» staxEventType | string | true | High level event type, typically mirrors Stax high-level feature name |
» staxEventName | string | true | Specific name of event; e.g., UserAuthenticationEvent, AccountCreated, CISNonCompliantRuleEvent |