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 Move To Pending

Usage

This file event triggers when a file's status is changed to the Pending status, meaning it has not completed its assigned pipeline.

When a file is in pending status, the extracted information, tag and indexing will not be available.

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.",
    "file_id": "(UUID format) - Unique identifier for the file associated with the event.",
    "file_name": "Filename of the document including its extension.",
    "file_name_without_extension": "Filename of the document excluding its extension.",
    "blob_name": "Path identifier of the document within the storage system indicating it is in a pending state.",
    "blob_url": "URL - Fully qualified URL where the document is stored, accessible via HTTP or HTTPS, indicating its location in a pending directory.",
    "creation_date": "(ISO 8601 date format) - Date and time when the file was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the file or event was last updated."
  }
}
{
  "event_id": "dcba4321-mlkj-9876-ponm-8765lkji4321",
  "event_type": "file_event_type",
  "event_time": "1651730100.00",
  "event": {
    "event_name": "file_move_to_pending_event",
    "event_type": "file_event_type",
    "company_id": "23456789-2345-2345-2345-2345678901bc",
    "company_name": "Innovate Ltd",
    "file_id": "98765432-5432-5432-5432-321098765432",
    "file_name": "monthly_report.xlsx",
    "file_name_without_extension": "monthly_report",
    "blob_name": "pending/monthly_report.xlsx",
    "blob_url": "https://storage.innovateltd.com/pending/monthly_report.xlsx",
    "creation_date": "2023-05-12T10:15:00Z",
    "update_date": "2023-05-12T11:30:00Z"
  }
}

Last updated 1 year ago

Was this helpful?