File Events

File Events in Alfred's Event API are a cornerstone in monitoring and managing the document processing workflow within the platform. These events are specifically designed to respond to a variety of actions or status changes related to files, making them a crucial element in tracking document progression and managing the automated workflow. Each File Event, such as "FileAddToJobEvent," "FileDoneEvent," or "FileFailedEvent," is triggered by a specific action, like adding a file to a job, completing file processing, or encountering a processing failure. This enables a responsive and interactive environment where changes in the file status are closely monitored and acted upon. These events are vital for applications that need to track the progress of files in real-time, manage document processing stages efficiently, and respond promptly to any changes in the file lifecycle.

Receiving File Events is streamlined through the Events API, which sends JSON-based payloads to a specified Webhook endpoint. This process is a part of the Event Loop, an event-driven sequence that starts with a user-triggered event, leading to the receipt of a JSON payload describing the event.

The system then acknowledges the event, and the server performs any required actions based on the event details. This loop, documented on the Event Loop documentation page, allows for a dynamic interaction between the Alfred platform and the user's application, ensuring that each significant file-related action is captured and can be acted upon in a timely manner.

File Event List

Event Type	Description
FileAddToJobEvent	Triggered when a file is added to a job for processing.
FileCategoryCreateEvent	Occurs when a new category is created for a file.
FileCategoryDeleteEvent	Signals the deletion of a file's category.
FileChangeTagEvent	Indicates a change in the tag associated with a file.
FileDoneEvent	Marks the completion of file processing.
FileExtractedDataCreateEvent	Triggered when new data is extracted from a file.
FileExtractedDataDeleteEvent	Occurs when extracted data from a file is deleted.
FileFailedEvent	Indicates a failure in file processing.
FileMoveEvent	Signals the movement of a file within the system.
FileMoveToPendingEvent	Triggered when a file is moved to a pending state.
FileMoveToRecycleBinEvent	Indicates movement of a file to the recycle bin.
FilePropertyCreateEvent	Reflects the creation of a file property.
FilePropertyDeleteEvent	Signals the deletion of a file property.
FileRemoveTagEvent	Signals the removal of a tag from a file.
FileStatusUpdateEvent	Indicates an update in the file's status.
FileUpdateEvent	Triggered when a file is updated in any manner.