Hire WorkforcePython SDKRequest Demo
Documentation

Folder

Suggest Edits

Folder created

This event occurs when a new folder is successfully created.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Folder 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 Folder 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": "folder c",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "c",
    "after": {
        "id": 0,
        "name": "MyFolder",
        "status": "NotStarted",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1718965669000,
        "updatedAt": 1718965669000,
        "project_id": 0
    },
    "ts_ms": 1718965669460,
    "before": null
}

Send Webhook Request

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

{
    "before": null,
    "after": {
        "id": 0,
        "project_id": 0,
        "name": "MyFolder",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1727782621000,
        "updatedAt": 1727782621000,
        "status": "NotStarted"
    },
    "op": "c",
    "ts_ms": 1727782621231
}

Send email body

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

Event - "Folder created"
Triggered by - "MyTeam/MyProject/MyFolder"

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

Folder status updated

This event is triggered when the status of the selected folder is updated.

Configuration

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

  • From: Specify the initial status of the folder before the update.
  • To: Define the new status that the folder 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).

Custom action input JSON

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

{
    "op": "u",
    "after": {
        "id": 0,
        "name": "MyFolder",
        "status": "Completed",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1718965669000,
        "updatedAt": 1718965678000,
        "project_id": 0
    },
    "ts_ms": 1718965678171,
    "before": {
        "id": 0,
        "name": "My Folder",
        "status": "NotStarted",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1718965669000,
        "updatedAt": 1718965669000,
        "project_id": 0
    }
}

Send Webhook Request

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

{
    "before": {
        "id": 0,
        "project_id": 0,
        "name": "MyFolder",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1727782621000,
        "updatedAt": 1727782621000,
        "status": "NotStarted"
    },
    "after": {
        "id": 0,
        "project_id": 0,
        "name": "MyFolder",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1727782621000,
        "updatedAt": 1727782627000,
        "status": "Completed"
    },
    "op": "u",
    "ts_ms": 1727782627138
}

Send email body

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

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

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

Folder deleted

This event occurs when the folder is successfully deleted.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Folder deleted 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).

Custom action input JSON

When the custom action is triggered by the Folder 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": "folder d",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

{
    "op": "d",
    "after": null,
    "ts_ms": 1718965658905,
    "before": {
        "id": 0,
        "name": "training",
        "status": "NotStarted",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1718801578000,
        "updatedAt": 1718801578000,
        "project_id": 0
    }
}

Send Webhook Request

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

{
    "before": {
        "id": 0,
        "project_id": 0,
        "name": "MyFolder",
        "is_root": false,
        "team_id": 0,
        "createdAt": 1727782621000,
        "updatedAt": 1727782627000,
        "status": "Completed"
    },
    "after": null,
    "op": "d",
    "ts_ms": 1727782631511
}

Send email body

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

Event - "Folder deleted"
Triggered by - "MyTeam/MyProject/MyFolder"

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

Updated 7 days ago