Item created

This event occurs when a new item is successfully created.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Item created event:

Scope: Specify whether the automation applies at a team level (All projects), or if it should be limited to a specific list of projects and folders (Specific projects).

🚧
Limitations and restrictions
The Item created event cannot be connected to the Send Email action.

Custom action input JSON

When the custom action is triggered by the Item created event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 5638215,
    "event": "EVENT_NAME",
    "ts_ms": 1769668854.819349,
    "source": {
        "folder_id": null,
        "project_id": 1302579
    },
    "pipeline_id": 28430,
    "pipeline_name": "Placeholder Pipeline",
    "trigger_result_id": 4746355
}

{
    "op": "c",
    "after": {
        "id": 0,
        "name": "item_1.png",
        "qa_id": null,
        "qa_name": null,
        "team_id": 0,
        "createdAt": 1718975785000,
        "folder_id": 0,
        "is_pinned": false,
        "source_id": "61c01d2b-9630-4bf1-a3ac-cd3fad35178f",
        "updatedAt": 1718975785000,
        "project_id": 0,
        "annotator_id": "[email protected]",
        "entropy_value": null,
        "annotator_name": "Annotator Name",
        "approval_status": null,
        "organization_id": "0",
        "annotation_status": "NotStarted",
        "prediction_status": 1,
        "segmentation_status": 1
    },
    "ts_ms": 1718975785761,
    "before": null
}

Send Webhook Request

When the Send webhook action is triggered by the Item created event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "item c",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "before": null,
    "after": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "item_1.png",
        "annotation_status": "NotStarted",
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784412000,
        "updatedAt": 1727784412000,
        "approval_status": null,
        "organization_id": "0"
    },
    "op": "c",
    "ts_ms": 1727784412904
}

Item opened in editor

This event occurs when an item is opened in the editor.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Item opened in editor event:

Scope: Specify whether the automation applies at a team level (All projects), or if it should be limited to a specific list of projects and folders (Specific projects).

🚧
Limitations and restrictions
The Item opened in editor event cannot be connected to the Send Email action.

Custom action input JSON

When the custom action is triggered by the Item opened in editor event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 2783511,
    "event": "item open",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "action": "ITEM_OPEN",
    "item_id": 0,
    "team_id": 0,
    "folder_id": 0,
    "item_name": "item_1.png",
    "user_name": "[email protected]",
    "user_role": "Admin",
    "ip_address": "178.160.196.42",
    "project_id": "0",
    "project_name": "MyProject"
}

Send webhook request

When the Send webhook action is triggered by the Item opened in editor event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "item open",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "ip_address": "178.160.196.42",
    "action": "ITEM_OPEN",
    "team_id": 4701,
    "project_id": "0",
    "project_name": "my_test",
    "folder_id": 0,
    "item_id": 0,
    "item_name": "item_1.png",
    "user_name": "[email protected]",
    "user_role": "Admin"
}

Item annotation status updated

This event occurs when the annotation status of an item is updated.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Item annotation status updated event:

From: Specify the initial status of the item before the update.
To: Define the new status that the item will have after the update.
Scope: Specify whether the automation applies at a team level (All projects), or if it should be limited to a specific list of projects and folders (Specific projects).

🚧
Limitations and restrictions
The Item annotation status updated event cannot be connected to the Send Email action.

📘
In case of status deletion
If a status is removed from a workflow and replaced by a new one, it may trigger any pipelines that are configured for projects using that workflow. This is based on the configuration of the Item annotation status updated event node tracking transitions made with this status.
If the status is deleted from the team, and there’s a queue of pipeline runs triggered by changes to it in a corresponding workflow, then the remaining runs in the queue will:

Continue being triggered with the status name changed to Unknown. This applies to the following event node configuration:

From: Any value, To: Any value

Be cancelled due to the status no longer being available. This applies to the following event node configurations:

From: Status, To: Any value

From: Status, To: Replacing status

Custom action input JSON

When the custom action is triggered by the Item annotation status updated event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 2783511,
    "event": "item u",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "u",
    "after": {
        "id": 0,
        "name": "item_1.png",
        "qa_id": null,
        "qa_name": null,
        "team_id": 0,
        "createdAt": 1727784413000,
        "folder_id": 0,
        "updatedAt": 1727785410000,
        "project_id": 0,
        "annotator_id": null,
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "organization_id": "0",
        "annotation_status": "QualityCheck"
    },
    "ts_ms": 1727785410458,
    "before": {
        "id": 0,
        "name": "image_1.png",
        "qa_id": null,
        "qa_name": null,
        "team_id": 0,
        "createdAt": 1727784413000,
        "folder_id": 0,
        "updatedAt": 1727784413000,
        "project_id": 0,
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "approval_status": null,
        "organization_id": "0",
        "annotation_status": "NotStarted"
    }
}

Send Webhook Request

When the Send webhook action is triggered by the Item annotation status updated event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "item u",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "before": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "image_1.png",
        "annotation_status": "NotStarted",
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784413000,
        "updatedAt": 1727784413000,
        "approval_status": null,
        "organization_id": "0"
    },
    "after": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "image_1.png",
        "annotation_status": "QualityCheck",
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784413000,
        "updatedAt": 1727785410000,
        "approval_status": null,
        "organization_id": "0"
    },
    "op": "u",
    "ts_ms": 1727785410458
}

Item approval status updated

This event occurs when the approval status of an item is updated.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Item approval status updated event:

From: Specify the initial status of the item before the update.
To: Define the new status that the item will have after the update.
Scope: Specify whether the automation applies at a team level (All projects), or if it should be limited to a specific list of projects and folders (Specific projects).

🚧
Limitations and restrictions
The Item approval status updated event cannot be connected to the Send Email action.

Custom Action Input JSON

When the custom action is triggered by the Item approval status updated event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 2783511,
    "event": "item u",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "u",
    "after": {
        "id": 0,
        "name": "image_1.png",
        "qa_id": null,
        "qa_name": null,
        "team_id": 0,
        "createdAt": 1727784412000,
        "folder_id": 0,
        "updatedAt": 1727785970000,
        "project_id": 0,
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "approval_status": "Disapproved",
        "organization_id": "image_1.png",
        "annotation_status": "QualityCheck"
    },
    "ts_ms": 1727785970863,
    "before": {
        "id": 0,
        "name": "image_1.png",
        "qa_id": null,
        "qa_name": null,
        "team_id": 0,
        "createdAt": 1727784412000,
        "folder_id": 0,
        "updatedAt": 1727785447000,
        "project_id": 0,
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "approval_status": null,
        "organization_id": "image_1.png",
        "annotation_status": "QualityCheck"
    }
}

Send Webhook Request

When the Send webhook action is triggered by the Item approval status updated event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "item u",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "before": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "image_1.png",
        "annotation_status": "QualityCheck",
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784413000,
        "updatedAt": 1727784413000,
        "approval_status": null,
        "organization_id": "0"
    },
    "after": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "image_1.png",
        "annotation_status": "QualityCheck",
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784413000,
        "updatedAt": 1727785410000,
        "approval_status": "Disapproved",
        "organization_id": "0"
    },
    "op": "u",
    "ts_ms": 1727785410458
}

Item assignment updated

This event occurs when an item's assignment is updated in a project.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Item assignment updated event:

Role: A multi-select dropdown where you can specify which role assignment updates will trigger the pipeline.
Action: You can select which action should trigger the event: Assign, Unassign, Any action.
- If an item already has an assignment in the role specified, then any reassignment will still be considered as both the Unassign and Assign actions. As such, reassignment will trigger the pipeline in any case.
Scope: Specify whether the automation applies at a team level (All projects), or if it should be limited to a specific list of projects and folders (Specific projects).

🚧
Limitations and restrictions
The Item assignment updated event cannot be connected to the Send Email action.

📘
In case of role deletion
If a role is removed from a workflow, it may trigger any pipelines that are configured for projects using that workflow. This is based on the configuration of the Item assignment updated event node tracking updates made with this role.
If the role is removed from the workflow, and there’s a queue of pipeline runs triggered by changes to it in a corresponding workflow, then the remaining runs in the queue will continue being triggered with the role name changed to Unknown, but the role_id will still remain the same.

Custom Action Input JSON

When the custom action is triggered by the Item assignment updated event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 5638185,
    "event": "item assignment updated",
    "ts_ms": 1769668546.459453,
    "source": {
        "folder_id": 1302579,
        "project_id": 1302579,
        "item_id": 1302579
    },
    "pipeline_id": 28430,
    "pipeline_name": "item assignment event pipeline",
    "trigger_result_id": 4746346
}

{
  "op": "assign",
  "ts_ms": 1774882054948,
  "after": <>,
  "before": {
      "id": 69356080,
      "folder_id": 1363766,
      "project_id": 1088717,
      "assignment": {
        "id": 25999269,
        "createdAt": 1697093636000,
        "item_id": 69356080,
        "state": "Confirmed",
        "updatedAt": 1697093636000,
        "user_email": "[email protected]",
        "user_name": "Name Surname",
        "role_name": "Annotator",
        "role_id": 112
      }
    }
  }
}

Send Webhook Request

When the Send webhook action is triggered by the Item assignment updated event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "item assignment updated",
    "X-Delivery": "5499749",
    "Content-Type": "application/json"
}

{
    "before": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "image_1.png",
        "annotation_status": "QualityCheck",
        "annotator_id": null,
        "annotator_name": null,
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784413000,
        "updatedAt": 1727784413000,
        "approval_status": "Disapproved",
        "organization_id": "0"
    },
    "after": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "folder_id": 0,
        "name": "image_1.png",
        "annotation_status": "QualityCheck",
        "annotator_id": "[email protected]",
        "annotator_name": "Annotator Name",
        "qa_id": null,
        "qa_name": null,
        "createdAt": 1727784413000,
        "updatedAt": 1727785410000,
        "approval_status": "Disapproved,
        "organization_id": "0"
    },
    "op": "u",
    "ts_ms": 1727785410458
}

Agent payload

 Process the following data: 
    <Same custom action payload>

Fired in Explore

This event can be used to run a pipeline on the selected items directly from Explore. For more details, see here.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Fired in Explore event:

Name: Specify a name for the card to display in the Explore, to indicate the associated pipeline.
Scope: Specify the project scope for this event so that it can only be used in either specific projects or in all projects of the team.

🚧
Limitations and restrictions

Action type: The Fired in Explore event cannot be connected to the Send Email action.

Name uniqueness: The card name must be unique.

Custom Action Input JSON

When the custom action is triggered by the Fired in Explore event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 2783511,
    "event": "item u",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
  "folders": [
        {
            "folder_id": 10,
            "item_ids": [1, 2]
        }
   ]
  "ts_ms": 1714729467825.9348,
  "team_id": 0,
  "user_id": "[email protected]",
  "project_id": 0
}

Send Webhook Request

When the Send webhook action is triggered by the Fired in Explore event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "item u",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "items": [
        1,
        2,
        3
    ],
    "ts_ms": 1727788126529.022,
    "team_id": 0,
    "user_id": "[email protected]",
    "project_id": 0
}