Export created

This event occurs when the preparation for the export of annotated data is started.

Configuration

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

Scope: Specify whether the automation applies at a team level (All projects), or limit its scope to a list of specific projects (Specific projects).

Custom action input JSON

When the custom action is triggered by the Export created 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": "export c",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "c",
    "after": {
        "id": 0,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": null,
        "status": "InProgress",
        "team_id": 0,
        "user_id": "[email protected]",
        "createdAt": 1718965685000,
        "updatedAt": 1718965685000,
        "project_id": 0,
        "integration_id": null,
        "progress_percent": -1
    },
    "ts_ms": 1718965685128,
    "before": null
}

Send Webhook Request

When the Send webhook action is triggered by the Export 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": "export c",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "before": null,
    "after": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "user_id": "[email protected]",
        "status": "InProgress",
        "progress_percent": -1,
        "createdAt": 1710246273000,
        "updatedAt": 1710246273000,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": null,
        "integration_id": null
    },
    "op": "c",
    "ts_ms": 1710246273670
}

Send email body

When the Send email action is triggered by an Export created event, the body of the email contains the following:

Event - "Export created"
Triggered by - "MyTeam/MyProject"

Event: The event type that triggers action, in this case, is "Export created"
Triggered by: Specifies the team and project that triggered the event, formatted as project path <team_name>/<project_name>. In this case, the event was triggered by the MyProject project within the MyTeam team.

Export status updated

This event occurs when the status of the export preparation for annotated data is updated.

Configuration

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

From: Specify the initial status from which the export process begins.
To: Determine the end status that the export process is expected to achieve.
Scope: Specify whether the automation applies at a team level (All projects), or limit its scope to a list of specific projects (Specific projects).

Custom action input JSON

When the custom action is triggered by the Export 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": 2757169,
    "event": "export u",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "u",
    "after": {
        "id": 0,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": "1768831",
        "status": "Completed",
        "team_id": 0,
        "user_id": "[email protected]",
        "createdAt": 1718965685000,
        "updatedAt": 1718965688000,
        "project_id": 0,
        "integration_id": null,
        "progress_percent": 100
    },
    "ts_ms": 1718965688709,
    "before": {
        "id": 0,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": "1768831",
        "status": "InProgress",
        "team_id": 0,
        "user_id": "[email protected]",
        "createdAt": 1718965685000,
        "updatedAt": 1718965685000,
        "project_id": 0,
        "integration_id": null,
        "progress_percent": -1
    }
}

Send Webhook Request

When the Send webhook action is triggered by the Export 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": "export u",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "op": "u",
    "after": {
        "id": 0,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": "1768831",
        "status": "Completed",
        "team_id": 0,
        "user_id": "[email protected]",
        "createdAt": 1718965685000,
        "updatedAt": 1718965688000,
        "project_id": 0,
        "integration_id": null,
        "progress_percent": 100
    },
    "ts_ms": 1718965688709,
    "before": {
        "id": 0,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": "1768831",
        "status": "InProgress",
        "team_id": 0,
        "user_id": "[email protected]",
        "createdAt": 1718965685000,
        "updatedAt": 1718965685000,
        "project_id": 0,
        "integration_id": null,
        "progress_percent": -1
    }
}

Send email body

When the Send email action is triggered by an Export status updated event, the body of the email contains the following:

Event - "Export status updated"
From Value - "NotStarted"
To Value - "Completed" 
Triggered by - "MyTeam/MyProject"

Event: The event type that triggers action, in this case.
From Value: The initial status of the export before the update.
To Value: The new status that the export will have after the update.
Triggered by: Specifies the team and project that triggered the event, formatted as project path <team_name>/<project_name>. In this case, the event was triggered by the MyProject project within the MyTeam team.

Export deleted

This event occurs when the prepared export for the annotated data is deleted.

Configuration

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

Scope: Specify whether the automation applies at a team level (All projects), or limit its scope to a list of specific projects (Specific projects).

Custom action input JSON

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

{
    "uuid": 2757169,
    "event": "export d",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "d",
    "after": null,
    "ts_ms": 1718965708039,
    "before": {
        "id": 0,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": "1768831",
        "status": "Completed",
        "team_id": 0,
        "user_id": "[email protected]",
        "createdAt": 1718965685000,
        "updatedAt": 1718965688000,
        "project_id": 0,
        "integration_id": null,
        "progress_percent": 100
    }
}

Send Webhook Request

When the Send webhook action is triggered by the Export deleted 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": "export d",
    "X-Delivery": "1704296",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "aff4a096a2cea275e1b4cfb5ea1724983bdb82895e"
}

{
    "before": {
        "id": 0,
        "team_id": 0,
        "project_id": 0,
        "user_id": "[email protected]",
        "status": "Completed",
        "progress_percent": 100,
        "createdAt": 1727777855000,
        "updatedAt": 1727777858000,
        "name": "MyProject.zip",
        "type": 2,
        "job_id": "4037597",
        "integration_id": null
    },
    "after": null,
    "op": "d",
    "ts_ms": 1727779342562
}

Send email body

When the Send email action is triggered by an Export deleted event, the body of the email contains the following:

Event - "Export deleted"
Triggered by - "MyTeam/MyProject"

Event: The event type that triggers action.
Triggered by: Specifies the team and project that triggered the event, formatted as project path <team_name>/<project_name>. In this case, the event was triggered by the MyProject project within the MyTeam team.