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. File Events

File Extracted Data Create

Usage

This file event triggers when a file has completed obtains the information from the file based on some parameters, once all the parameters are complete, it will extract the information to pass it to text.

Once in our system, this file will be classified, indexed and the configured data points of its labels will be extracted.

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, including tenths of a second.",
  "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.",
    "file_log_id": "(UUID format) - Unique identifier for the log entry related to the file event.",
    "content": "Text - Extracted textual content or data from the file.",
    "provider": "Name of the service provider that performed the data extraction.",
    "creation_date": "(ISO 8601 date format) - Date and time when the extracted data was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the extracted data or event log was last updated."
  }
}
{
  "event_id": "mnop4567-qr89-0123-st45-uvwxy6789012",
  "event_type": "file_event_type",
  "event_time": "1651325678.10",
  "event": {
    "event_name": "file_extracted_data_create_event",
    "event_type": "file_event_type",
    "company_id": "678m7891-n23o-67h8-f012-548614182000",
    "company_name": "TechAdventures",
    "file_log_id": "456n9012-o34p-78i9-j123-659314183000",
    "content": "Extracted text content or data from the document...",
    "provider": "DataExtractionService",
    "creation_date": "2023-05-03T10:15:00Z",
    "update_date": "2023-05-04T12:20:00Z"
  }
}

Last updated 1 year ago

Was this helpful?