For the complete documentation index, see llms.txt. This page is also available as Markdown.

Audit Event Type

Audit Event Type refers to an event that has occurred within the platform. These records are generated automatically and can be used to store supplementary information related to the specific event type.

Field
Type
Description

id

string, core

(Read-only) The ID of the item.

key

string, core

(Read-only) The event's key.

name

string, core

(Read-only) The name of the event.

description

string

(Read-only) (Optional) A description of the event.

Example

AUDIT EVENT TYPE OBJECT
{
  "id": "AET-5699-2751",
  "Key": "platform.commerce.order.created",
  "Name": "Order created.",
  "Description": "A standard event that occurs upon the creation of an order."
},

Last updated

Was this helpful?