Skip to main content

Action Event

Action event are used to track activities that occur in the system. These events are used to track the history of the system and are used to generate reports.

Fields

Field NameTypeDisplay Name
EventIdGuidEvent id
CreatedDateTimeCreated
CreatedByStringCreated by
ErrorMessageStringError message
EventDataDictionary`2Event data
EventNameStringEvent name
OrganizationIdInt32Organization id
StatusEventStatusStatus

Naming Convention:

  • <entity>.<action>
  • <entity>.<action>.<sub-action>
  • <app>.<entity>.<action>

Examples of action events are:

  • commodity.scan
  • order.print_label.shipping
  • order.receive

Event Data

Event data is a JSON object that contains the data related to the event. The data is stored in the eventData property of the event.

Status

Status is used to track the status of the event. The status can be one of the following:

  • Pending
  • Completed
  • Failed

Validations for Action Events

Actions events are validated using business rules. During the validation process, the system checks if the event is valid and if the event is valid, the system will execute the event. If the event is not valid, the system will not execute the event.