Skip to content

Event

An Event is a virtual representation of an operation, an event, or an action that occurs in the platform.

This Event can be used for:

  • Audit Log: register all major events that occur in the platform. Example: device creation, device deletion, platform technical error ...
  • Standard business purpose: business events managed directly by the platform. Example: battery level warning, ...
  • Custom business purpose: all events generated by a custom app that can be used for dedicated scenarios.

Event Details

  • Tenant ID: ID of the Tenant in which the Event occurred
  • Target Entity Type: Records the Entity Type for which the event occurred. Can be a Device, Folder, User, Tenant ...
  • Target Entity ID: ID of the Entity for which the event occurred
  • Criticality: a predefined range of levels to classify the importance of the Event
    • 0: Not applicable
    • 1: CRITICAL
    • 2: HIGH
    • 3: MEDIUM
    • 4: LOW
    • 5: TRIVIAL
  • Event Code:
    • 0 to 10000: reserved for the system.
    • 10000 and above: free to use for business app usage
  • Internal:
    • internal Events can only be generated by the platform, they use system Event codes
    • custom Events (non-internal) can be created in the platform with any code
  • Payload Content-Type: the type of data stored in the payload encoded in payload data.
  • Payload data: Stores additional information or Event parameters

List Events

Permission

  • read event.tenant

Feature

  • Users can read the latest Events based on specific parameters
  • Supported filter parameters:
    • Date Range (mandatory), if only one date is specified, range is automatically between the date and NOW.
    • Criticality
    • Event Code
    • Target Entity ID
    • Target Entity Type
  • The response can be paginated and ordered by date ASC or DESC.

Generate an Event

Permission

  • create event.tenant

Feature

  • Users can generate Events to keep track of actions or events that occurred in the platform
  • Generating a new Event is based on available parameters described in 'Event Details' The Event datetime is generated automatically by the platform when the API is called