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 Add To Job

Usage

This file event triggers when a file has been uploaded and successfully linked to a job. The event is triggered whenever a file is associated with a job, irrespective of the integration mechanism used—whether through Alfred Desktop, email ingestion via Pointguard, or any other client or tool. Once in our system, the uploaded file will follow the assigned pipeline for the job.

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_id": "(UUID format) - Unique identifier for the file involved in the event.",
    "job_id": "(UUID format) - Unique identifier for the job associated with the file and event."
  }
}
{
  "event_id": "e0f8b2e6-c1c9-4b34-8e5f-a10b7b760e75",
  "event_type": "file_event_type",
  "event_time": "1651018865.75",
  "event": {
    "event_name": "file_added_to_job_event",
    "event_type": "file_event_type",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Example Company",
    "file_id": "123e4567-e89b-12d3-a456-426614174001",
    "job_id": "123e4567-e89b-12d3-a456-426614174002"
  }
}

Last updated 1 year ago

Was this helpful?