Skip to content

label.workflow.edited

Python model

LabelWorkflowEditedEvent — from kili_events import LabelWorkflowEditedEvent

Description

This event is raised once a label is edited during review, i.e. the reviewer submits a review label that differs from the label being reviewed.

Properties

event

  • Required
  • The name of the event.
  • Constant value: "label.workflow.edited"

project_id

  • Required
  • Type: string
  • Id of the project to which the label belongs.

user_id

  • Required
  • Type: string
  • Id of the reviewer who edited the label.

organization_id

  • Required
  • Type: string
  • Id of the organization in which the project was created. It references the project author organization.

payload

  • Required
  • Type: object
  • The payload of the event. The rest of the label data can be fetched by the label id.
  • Properties
    • label_id
      • Required
      • Type: string
      • Id of the edited review label.
    • asset_id
      • Required
      • Type: string
      • Id of the labeled asset.
    • external_id
      • Required
      • Types: string, null
      • External id of the labeled asset.

event

  • Required
  • The name of the event.
  • Constant value: "label.workflow.edited"

projectId

  • Required
  • Type: string
  • Id of the project to which the label belongs.

userId

  • Required
  • Type: string
  • Id of the reviewer who edited the label.

organizationId

  • Required
  • Type: string
  • Id of the organization in which the project was created. It references the project author organization.

payload

  • Required
  • Type: object
  • The payload of the event. The rest of the label data can be fetched by the label id.
  • Properties
    • labelId
      • Required
      • Type: string
      • Id of the edited review label.
    • assetId
      • Required
      • Type: string
      • Id of the labeled asset.
    • externalId
      • Required
      • Types: string, null
      • External id of the labeled asset.