Audit Record
he Audit Record object provides a detailed record of a specific event that occurred within the platform. This object contains the following properties:
id
string
A unique identifier for the audit record. Note that no nesting exists for this identifier.
Example: AUD-1671-0642-1234-1234
event
string
The event code. Format: {platform/extension}.{module/extension name}.{object}.{action}
Example: platform.commerce.order.created
summary
string
A summary of the audit record.
Example: Order created
details
string
The audit details template. Any document property may be used as a placeholder.
Example: The order {{order.id}} has been successfully created by {{actor.name}} and is now in the platform.
actor
auditrecord Actor
Information about the actor who has triggered an event.
Example:
object
auditrecord Object
The API object for which an event has been triggered.
Example:
timestamp
dateTime
The timestamp of the event.
Example: 2024-07-25T09:09:30.087Z
type
auditRecordType Enum
The visibility of the audit record.
Possible values: Public or Private.
request
request
The request for technical data.
Example:
documents
object
A JSON element containing a collection of linked Event Record objects.
Example:
viewers
viewer
A list of accounts that have access to the audit records.
Example:
Example
Last updated
Was this helpful?