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
  • Example JSON Payload

Was this helpful?

  1. Event API
  2. File Events

File Category Create

Usage

This file event triggers when a tag has been successfully assigned to a specific file within the Alfred platform. In the description key it is possible to find the tag under which the file was classified.

The file will continue the corresponding pipeline after a successful classification.

Example 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 milliseconds.",
  "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 associated with the event.",
    "company_name": "Name of the company associated with the event.",
    "file_log_id": "(UUID format) - Unique identifier for the log entry related to the file event.",
    "description": "Brief textual description of the event or action taken.",
    "confidence": "(floating-point numeric value) - Confidence level of the action taken or the classification, typically between 0.0 and 1.0.",
    "creation_date": "(ISO 8601 date format) - Date and time when the file category was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the file category was last updated."
  }
}
{
  "event_id": "abcd1234-ef56-7890-gh12-ijkl34567890",
  "event_type": "file_event_type",
  "event_time": "1651018865.75",
  "event": {
    "event_name": "file_category_create_event",
    "event_type": "file_event_type",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Example Company",
    "file_log_id": "123e4567-e89b-12d3-a456-426614174002",
    "description": "Initial classification",
    "confidence": "0.95",
    "creation_date": "2023-04-26T12:00:00Z",
    "update_date": "2023-04-27T12:00:00Z"
  }
}

Last updated 1 year ago

Was this helpful?