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

Usage

This file event triggers when the location of a file has been modified. Files may be moved due to the following reasons:

  • When a file is classified, it will move to the corresponding directory,

  • When a file fails to be classified, it will move the No Tag directory.

  • When its processing pipeline fails.

  • When a user voluntarily move the file to the Recycle Bin.

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.",
    "blob_url": "URL - Fully qualified URL where the document is stored, accessible via HTTP or HTTPS.",
    "previous_file_directory": "Path - Previous directory path where the file was stored.",
    "new_file_directory": "Path - New directory path to which the file has been moved.",
    "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": "abcd2345-efgh-6789-ijkl-1234mnop5678",
  "event_type": "file_event_type",
  "event_time": "1651629000.00",
  "event": {
    "event_name": "file_move_event",
    "event_type": "file_event_type",
    "company_id": "12345678-1234-1234-1234-1234567890ab",
    "company_name": "Global Corp",
    "file_id": "87654321-4321-4321-4321-210987654321",
    "file_name": "report_2023.docx",
    "file_name_without_extension": "report_2023",
    "blob_name": "2023/reports/report_2023.docx",
    "blob_url": "https://storage.globalcorp.com/2023/reports/report_2023.docx",
    "previous_file_directory": "/previous_directory/2023/reports/",
    "new_file_directory": "/new_directory/2023/reports/",
    "creation_date": "2023-05-10T08:00:00Z",
    "update_date": "2023-05-10T09:00:00Z"
  }
}
                        

Last updated 1 year ago

Was this helpful?