File Done

Usage

This file event triggers when a file has successfully completed all of the stages defined in its assigned pipeline. A file’s pipeline will be dependent of its Tag and the configured options via our administrative panel.

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, 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.",
    "blob_name": "Filename of the document or data blob.",
    "blob_url": "URL - Fully qualified URL where the blob or document is stored, accessible via HTTP or HTTPS.",
    "file_id": "(UUID format) - Unique identifier for the file associated with the event.",
    "tag_id": "(UUID format) - Unique identifier for the tag associated with the file.",
    "tag_name": "Name of the tag assigned to the file.",
    "file_status": "Status of the file, typically a textual description like 'completed', 'processing', etc.",
    "creation_date": "(ISO 8601 date format) - Date and time when the file or event was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the file or event was last updated."
  }
}

{
  "event_id": "fghi3456-kl78-9012-mn34-opqr56789012",
  "event_type": "file_event_type",
  "event_time": "1651224567.00",
  "event": {
    "event_name": "file_done_event",
    "event_type": "file_event_type",
    "company_id": "567j6789-k89l-34e6-c789-527614179000",
    "company_name": "Innovatech Ltd",
    "blob_name": "example_document.pdf",
    "blob_url": "https://storage.example.com/documents/example_document.pdf",
    "file_id": "890k7890-l12m-45f6-d890-638214180000",
    "tag_id": "345l8901-m23n-56g7-e901-739414181000",
    "tag_name": "Approved",
    "file_status": "completed",
    "creation_date": "2023-05-01T09:30:00Z",
    "update_date": "2023-05-02T11:45:00Z"
  }
}