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 Recycle Bin

Usage

This file event triggers when a File has been moved to the Recycle Bin. Once a file has been uploaded to Alfred it cannot be removed completely. When placed in the Recycle Bin, the file will be ignored for historical purposes and model training purposes. It will still show up in search results and be available for audit purposes. Moving a file to the recycle bin is an explicit action performed via a context menu in our Web application. You can click on the option using the context menu in the File Detail view.

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 has been moved to the recycle bin.",
    "blob_url": "URL - Fully qualified URL where the document is stored, accessible via HTTP or HTTPS, indicating its location in the recycle bin.",
    "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": "efgh8765-nopq-5432-cdef-5432abcd6789",
  "event_type": "file_event_type",
  "event_time": "1651831200.00",
  "event": {
    "event_name": "file_move_to_recycle_bin_event",
    "event_type": "file_event_type",
    "company_id": "34567890-3456-3456-3456-3456789012cd",
    "company_name": "Creative Solutions",
    "file_id": "09876543-6543-6543-6543-432109876543",
    "file_name": "proposal_draft.docx",
    "file_name_without_extension": "proposal_draft",
    "blob_name": "recycle_bin/proposal_draft.docx",
    "blob_url": "https://storage.creativesol.com/recycle_bin/proposal_draft.docx",
    "creation_date": "2023-05-15T12:20:00Z",
    "update_date": "2023-05-15T13:35:00Z"
  }
}

Last updated 1 year ago

Was this helpful?