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

JobStageUpdateEvent

Usage

This event triggers when a job successfully transitions from one stage to another within its state machine. This may occur when:

  • Successful document classification leading to extraction.

  • Successful extraction leading to indexing.

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 whose stage is being updated.",
    "stage": "Current stage of the job process, such as 'processing', indicating the job's progress or current activity.",
    "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's stage or event details were last updated."
  }
}
{
  "event_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  "event_type": "job_event_type",
  "event_time": "1653544200.00",
  "event": {
    "event_name": "job_stage_update_event",
    "event_type": "job_event_type",
    "company_id": "45678901-2345-2345-2345-234567890def",
    "company_name": "Dynamic Solutions",
    "job_id": "56789012-3456-3456-3456-345678901fgh",
    "stage": "processing",
    "creation_date": "2023-05-25T22:10:00Z",
    "update_date": "2023-05-25T23:40:00Z"
  }
}

Last updated 1 year ago

Was this helpful?