Alfred v1.66.3.0
Alfred
Alfred
  • Introduction
  • Authentication
  • Event API
    • File Events
      • File Add To Job
      • File Category Create
      • File Category Delete
      • File Change Tag
      • File Done
      • File Extracted Data Create
      • File Extracted Data Delete
      • File Failed
      • File Move
      • File Move To Pending
      • File Move To Recycle Bin
      • File Property Create
      • File Property Delete
      • File Remove Tag
      • File Status Update
      • File Update
    • Job Events
      • JobCreateEvent
      • JobExceededRetriesEvent
      • JobFailedEvent
      • JobFinishedEvent
      • JobInvalidEvent
      • JobRetryEvent
      • JobStageUpdateEvent
      • JobStartEvent
    • Event Structures
  • endpoints
    • Alfred
    • File
      • Remote Sources
      • File Status
    • Deferred Session
    • Job
      • Job Stages
    • Tag
    • Metadata
    • Metadata Values
    • Report
    • Account
    • Company
Powered by GitBook
On this page
  • Usage
  • JSON Payload

Was this helpful?

  1. Event API
  2. Job Events

JobStartEvent

Usage

This event triggers when a job begins its workflow, initiating its state machine. Some examples of this event triggering are:

  • Commencement of a scheduled batch job for nightly processing.

  • Start of an ad-hoc job for immediate document processing.

JSON Payload

{
  "event_id": "(UUID format) - Unique identifier for the event.",
  "event_type": "Describes the type of event that occurred.",
  "event_time": "(floating-point numeric timestamp) - Unix timestamp representing the time when the event occurred, rounded to whole seconds.",
  "event": {
    "event_name": "Name of the specific event.",
    "event_type": "Type of the event, often matching or related to the outer event_type.",
    "company_id": "(UUID format) - Unique identifier for the company involved in the event.",
    "company_name": "Name of the company involved in the event.",
    "job_id": "(UUID format) - Unique identifier for the job that has just begun.",
    "creation_date": "(ISO 8601 date format) - Date and time when the job was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the job or event details were last updated, marking the start of the job."
  }
}
 {
  "event_id": "d2e3f4g5-h6i7-j8k9-l0m1-n2o3p4q5r6s7",
  "event_type": "job_event_type",
  "event_time": "1653645300.00",
  "event": {
    "event_name": "job_start_event",
    "event_type": "job_event_type",
    "company_id": "67890123-4567-4567-4567-456789012ghi",
    "company_name": "Innovate Logistics",
    "job_id": "78901234-5678-5678-5678-567890123jkl",
    "creation_date": "2023-05-26T23:20:00Z",
    "update_date": "2023-05-27T00:50:00Z"
  }
}

Last updated 1 year ago

Was this helpful?