Skip to content

label.workflow.revisionStarted

Python model

LabelWorkflowRevisionStartedEvent — from kili_events import LabelWorkflowRevisionStartedEvent

Description

This event is raised once a label revision is started (user clicks on Revise label).

Properties

event

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

project_id

  • Required
  • Type: string
  • Id of the project in which the action was done.

user_id

  • Required
  • Type: string
  • Id of the user who did the action.

organization_id

  • Required
  • Type: string
  • Id of the organization in which the action was done. For project related event, it references the project author organization.

payload

  • Required
  • Type: object
  • Properties
    • asset_id
      • Required
      • Type: string
      • Id of the targeted asset.
    • external_id
      • Required
      • Types: string, null
      • External id of the targeted asset.
    • previous_step_id
      • Required
      • Type: string
      • Id of the previous step.
    • new_step_id
      • Required
      • Type: string
      • Id of the new step.
    • label_id
      • Type: string
      • Id of the label the action was performed on, when available.

event

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

projectId

  • Required
  • Type: string
  • Id of the project in which the action was done.

userId

  • Required
  • Type: string
  • Id of the user who did the action.

organizationId

  • Required
  • Type: string
  • Id of the organization in which the action was done. For project related event, it references the project author organization.

payload

  • Required
  • Type: object
  • Properties
    • assetId
      • Required
      • Type: string
      • Id of the targeted asset.
    • externalId
      • Required
      • Types: string, null
      • External id of the targeted asset.
    • previousStepId
      • Required
      • Type: string
      • Id of the previous step.
    • newStepId
      • Required
      • Type: string
      • Id of the new step.
    • labelId
      • Type: string
      • Id of the label the action was performed on, when available.