File Change Tag

Usage

This file event notifies your application when a file’s tag has been changed either by constraints set within the pipeline or manually by a human validator. When the verification step is enabled for a given tag, a user with the validator role has the ability of setting a different tag. This is an explicit action that is performed through a context menu in our web application. You can access this option via the File Verification view.

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 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.",
    "previous_tag_id": "(UUID format) - Unique identifier for the file's previous tag.",
    "previous_tag_name": "Textual description of the previous tag or 'null' if none existed.",
    "proposed_tag_id": "(UUID format) - Unique identifier for the proposed new tag for the file.",
    "classification_score": "(floating-point numeric value) - Score representing the confidence or relevance of the new tag, typically between 0.0 and 1.0.",
    "new_tag_id": "(UUID format) - Unique identifier for the newly assigned tag to the file.",
    "new_tag_name": "Name of the newly assigned tag."
  }
}

{
  "event_id": "defg2345-hi67-8901-jk23-lmnop7890123",
  "event_type": "file_event_type",
  "event_time": "1651123456.90",
  "event": {
    "event_name": "file_change_tag_event",
    "event_type": "file_event_type",
    "company_id": "456f5678-g89h-23d4-b567-426614175000",
    "company_name": "Dynamic Solutions",
    "file_id": "789g6789-h12i-34d5-e678-529214176000",
    "previous_tag_id": "00000000-0000-0000-0000-000000000000",
    "previous_tag_name": "null",
    "proposed_tag_id": "891h7890-i23j-45d6-f789-630314177000",
    "classification_score": "0.88",
    "new_tag_id": "234i3456-j45k-56e7-g891-731414178000",
    "new_tag_name": "Urgent"
  }
}