JobCreateEvent

Usage

This event is triggered when a new job is instantiated to handle a file or set of files for classification, extraction, and indexing. Common examples of this event triggering:

• Batch upload of scanned invoices for indexing.

• Single-file upload for immediate processing.

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.",
    "job_id": "(UUID format) - Unique identifier for the job created as part of the event.",
    "user_name": "Username of the individual who initiated the job.",
    "merge": "Boolean - Indicates whether the job involves merging files or similar operations.",
    "metadata": "Text - Descriptive information or summary about the job, such as its purpose or contents.",
    "file_count": "Integer - The number of files involved in the job.",
    "company_id": "(UUID format) - Unique identifier for the company associated with the job.",
    "company_name": "Name of the company associated with the job.",
    "file_urls": "Array of URLs - List of fully qualified URLs where the associated files are stored, accessible via HTTP or HTTPS.",
    "creation_date": "(ISO 8601 date format) - Date and time when the job was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the job details were last updated."
  }
}

{
  "event_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  "event_type": "job_event_type",
  "event_time": "1652937600.00",
  "event": {
    "event_name": "job_create_event",
    "event_type": "job_event_type",
    "job_id": "12345678-1234-1234-1234-123456789abc",
    "user_name": "john_doe",
    "merge": "true",
    "metadata": "Batch processing of May invoices",
    "file_count": "150",
    "company_id": "87654321-4321-4321-4321-432143214321",
    "company_name": "Acme Corp",
    "file_urls": [
      "https://example.com/files/invoice1.pdf",
      "https://example.com/files/invoice2.pdf"
      // More URLs can be added as needed
    ],
    "creation_date": "2023-05-19T12:00:00Z",
    "update_date": "2023-05-19T12:30:00Z"
  }
}