Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Audit Events

Get an Audit Event

Gets an audit event by its ID.

get/v2.0/auditevents/{auditEventId}

Path parameters

auditEventIdstring required

Audit event ID

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns audit event object

idstring
timestampstring

The timestamp when the action happened

type'action' | 'create' | 'replace' | 'patch' | 'delete' | 'authentication' | 'authorization'

The type of operation that was performed

userstring

The email of the user who performed the operation

payloadobject

The raw payload of the operation in case it was tracked

Example response

{
  "timestamp": "2020-04-27T14:22:11.000Z",
  "type": "create",
  "user": "hans.mustermann@xyz.com",
  "modifiedResources": [
    {
      "resourceId": "5e997f0cdcfc57730cf32941",
      "resourceType": "node"
    }
  ],
  "payload": {
    "name": "new resource name"
  }
}