An event is an activity that takes place within SuperAnnotate, like updating an item's status. When setting up an automation, you should choose which event in SuperAnnotate should trigger it.

For example, if you subscribe to the Project Created event, you'll receive detailed payloads every time a project is created. When an event is triggered, we'll send an HTTP POST request to the selected action of automation.

The common content of the HTTP header is given below. Note that the Content-Type is always application/ json.

You can use the X-Authorization-Content-Sha256 key for authorization.

{
  "Host": "web:8001",
  "Accept": "application/json;charset=UTF-8",
  "X-Event": "item",
  "Connection": "close",
  "User-Agent": "python-urllib3/1.26.14",
  "X-Delivery": "0ae5560f-afa5-499b-b23e-118bb54a94bf",
  "Content-Type": "application/json",
  "Content-Length": "936",
  "Accept-Encoding": "identity",
  "X-Amzn-Trace-Id": "Root=1-63d79f8b-48d03ea01e91192b4e007ad2",
  "X-Forwarded-For": "44.193.142.184",
  "X-Forwarded-Port": "443",
  "X-Forwarded-Proto": "https",
  "X-Authorization-Content-Sha256": "aba5081f263ebb4dd762a4aad713dd56b833d7009b0d525736478935de12b767"
}

📘

The events are applied to the following scopes: Projects, Folder, Item, and Export.

Each event description includes a detailed list of its properties and a sample payload.

Project

EventDescription
Project CreatedAn annotation project is created.
Project Status UpdatedThe status of an annotation project is updated. You can subscribe to a specific status change, for example, when a project's status changes from In Progress to Completed. To do that, you should select a To value and a From value. The values are:
Any value, Undefined, Not Started, In Progress, On Hold, and Completed.
Project DeletedAn annotation project is deleted.

Find below the sample payloads for each project-related event below.

{
   "op":"c",
   "before":null,
   "after":{
      "id":122217,
      "name":"Segmentation",
      "type":"Vector",
      "status":"NotStarted",
      "team_id":19744,
      "createdAt":1675077226000,
      "deletedAt":null,
      "is_pinned":false,
      "updatedAt":1675077226000,
      "creator_id":"[email protected]",
      "description":"descript",
      "upload_state":"Initial",
      "entropy_status":"NotStarted",
      "sharing_status":null,
      "attachment_name":null,
      "attachment_path":null,
      "custom_editor_url":null
   },
   "ts_ms":1675077226469,
}
{
  "op": "d", 
  "before": {
    "id": 309508,
    "name": "Segmentation",
    "status": "Completed",
    "is_root": false,
    "team_id": 19744,
    "createdAt": 1675077230000,
    "updatedAt": 1675077268000,
    "project_id": 122217
  },
  "after": null,
  "ts_ms": 1675077273892,
}

Folder

EventDescription
Folder CreatedA folder is created in an annotation project.
Folder Status UpdatedThe status of a folder is updated. You can subscribe to a specific status change, for example, when a folder's status changes from In Progress to Completed. To do that, you should select a To value and a From value. The values are:
Any value, Undefined, Not Started, In Progress, On Hold, and Completed.
Folder DeletedA folder is deleted in an annotation project.

Please find sample payloads for each folder-related event below.

{
  "op": "c",
  "before": null,
  "after": {
    "id": 309508,
    "name": "Batch 2",
    "status": "NotStarted",
    "is_root": false,
    "team_id": 19744,
    "createdAt": 1675077230000,
    "updatedAt": 1675077230000,
    "project_id": 122217
  },
  "ts_ms": 1675077230816
}
{
  "op": "d",
  "before": {
    "id": 309508,
    "name": "Batch 1",
    "status": "Completed",
    "is_root": false,
    "team_id": 19744,
    "createdAt": 1675077230000,
    "updatedAt": 1675077268000,
    "project_id": 122217
  },
  "after": null,
  "ts_ms": 1675077273892
}

Item

EventDescription
Item CreatedAn item is added to the project.
Item Status UpdatedThe annotation status of an item is updated. You can subscribe to a specific status change, for example, when an item's status changes from In Progress to Completed. To do that, you should select a To value and a From value. The values are: Any Value, Not Started, In Progress, Quality Check, Returned, and Completed.
Item Approval UpdatedThe approval status of an item is updated. You can subscribe to a specific status change, for example, when an item's approval status changes from In Progress to Completed. To do that, you should select a To value and a From value. The values are: Any Value, No Value, Approved, and Disapproved.
Item Annotator Assignment UpdatedThe annotator assignment of an item is updated. You can subscribe to a specific assignment change, for example, when an item is assigned an annotator. To do that, you should select a To value and a From value. The values are: Any Value and No Value.
Item QA Assignment UpdatedThe QA assignment of an item is updated. You can subscribe to a specific assignment change, for example, when an item is assigned a QA. To do that, you should select a To value and a From value. The values are: Any Value and No Value.

Please find sample payloads for each item-related event below.

{
  "op": "u",
  "before": {
    "id": 41158539,
    "name": "test.jpeg",
    "qa_id": null,
    "qa_name": null,
    "team_id": 19744,
    "createdAt": 1675075465000,
    "folder_id": 309326,
    "is_pinned": false,
    "source_id": "4792bc5e-9ad6-4f04-85d9-2fcd63c088d1",
    "updatedAt": 1675075465000,
    "project_id": 122101,
    "annotator_id": null,
    "entropy_value": null,
    "annotator_name": null,
    "approval_status": null,
    "annotation_status": "NotStarted",
    "prediction_status": 1,
    "segmentation_status": 1
  },
  "after": {
    "id": 41158539,
    "name": "test.jpeg",
    "qa_id": null,
    "qa_name": null,
    "team_id": 19744,
    "createdAt": 1675075465000,
    "folder_id": 309326,
    "is_pinned": false,
    "source_id": "4792bc5e-9ad6-4f04-85d9-2fcd63c088d1",
    "updatedAt": 1675075467000,
    "project_id": 122101,
    "annotator_id": null,
    "entropy_value": null,
    "annotator_name": null,
    "approval_status": null,
    "annotation_status": "InProgress",
    "prediction_status": 1,
    "segmentation_status": 1
  },
  "ts_ms": 1675075467014,
    
}

Export

EventDescription
Export CreatedThe export preparation of the annotation project is triggered.
Export Status UpdatedThe status project export is updated. You can subscribe to a specific status change, for example, when an export's status changes from In Progress to Completed. To do that, you should select a To value and a From value. The values are: Any Value, In Progress, Complete, Canceled, and Error.
Export DeletedA project export is deleted.

Please find sample payloads for each export-related event below.

{
  "op": "u",
  "after": {
    "id": 64750,
    "name": "segmentation Jan 30.zip",
    "type": 1,
    "status": "Completed",
    "team_id": 19744,
    "user_id": "[email protected]",
    "createdAt": 1675077238000,
    "updatedAt": 1675077248000,
    "project_id": 122217,
    "progress_percent": 100
  },
  "ts_ms": 1675077248957,
  "before": {
    "id": 64750,
    "name": "segmentation Jan 30.zip",
    "type": 1,
    "status": "InProgress",
    "team_id": 19744,
    "user_id": "[email protected]",
    "createdAt": 1675077238000,
    "updatedAt": 1675077248000,
    "project_id": 122217,
    "progress_percent": 0
  }
}