Event Structures

Event API

Event API distinguishes between two distinct event types that provide timely and relevant information of generated Jobs

Job Events

Job Events provide comprehensive details about jobs that are new, existing, or completed within the Alfred platform. These events can be retrieved regardless of whether they originated from a third-party application or were initiated directly within Alfred.

The JSON payload format for these events is as follows:

{
  "event_id": "A unique identifier for the event",
  "event_type": "The specific type of event that occurred",
  "event_time": "A Unix timestamp indicating when the event occurred",
  "event": {
    "description": "A detailed structure that varies based on the specific event."
  }
}

This structure ensures that users have access to consistent and essential information about each job event.

File Events

Job Events provide comprehensive details about specific files that belong to a job within the Alfred platform. These events can be retrieved regardless of whether they originated from a third-party application or were initiated directly within Alfred.

The JSON payload format for these events is as follows:

{
  "event_id": "A unique identifier for the event",
  "event_type": "The specific type of event that occurred",
  "event_time": "A Unix timestamp indicating when the event occurred",
  "event": {
    "description": "A detailed structure that varies based on the specific event."
  }
}