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

Was this helpful?

  1. Event API

Job Events

Last updated 1 year ago

Was this helpful?

Alfred performs asynchronous document classification, extraction, and indexing on a variety of file types, from scanned images to digital documents. Each Job in Alfred encapsulates the complete workflow needed to process one or more files. The events detailed here offer insights into how a Job progresses, fails, retries, or completes its tasks, serving as crucial hooks for your application's business logic and event-driven architecture.

Whether you are integrating Alfred into a financial service application to process invoices, or into a healthcare system to categorize and index patient records, understanding these Job events will empower you to build more robust and responsive applications.

Job Events List

Event Name

Job Events

Triggered when a new job is instantiated for file operations.

Fires when job exceeds maximum retry attempts for a stage.

Occurs when a job halts due to an unrecoverable error.

Triggered when job successfully completes all workflow stages.

Fires when job fails initial validation of input files or parameters.

Triggered when job retries a stage after a recoverable failure.

Occurs when job transitions from one workflow stage to another.

Triggered when job begins its workflow and state machine.

JobCreateEvent
JobExceededRetriesEvent
JobFailedEvent
JobFinishedEvent
JobInvalidEvent
JobRetryEvent
JobStageUpdateEvent
JobStartEvent