Hire WorkforcePython SDKRequest Demo

Managing pipelines

Suggest Edits

When viewing your pipelines, you can manage them in a number of ways. You can rename, edit, disable, enable and delete them from this list. If you want to see more detailed information about the pipeline and each action that it has carried out, you can do so by clicking on it.

Rename

There are two ways you can rename a pipeline.

Method 1

  1. Find the pipeline you want to rename.
  2. Click on the three dots ⋮.
  3. Click Rename.
  4. Type in a new name.
  5. Click Save.

Method 2

  1. Click on the pipeline you want to rename.
  2. Click the edit button next to Pipeline name.
  3. Type in a new name.
  4. Click Save.

Edit

Editing a pipeline allows you to make changes to the automations you’ve set up within it. There are two ways to do so.

Method 1

  1. Find the pipeline you want to edit.
  2. Click on the three dots ⋮.
  3. Click Edit.
  4. Make your changes and additions in the canvas.
  5. When you’re done, click Save.

Method 2

  1. Click on the pipeline you want to edit.
  2. Click on View pipeline.
  3. Make your changes and additions in the canvas.
  4. When you’re done, click Save.

Disable

There are two ways you can disable a pipeline. This won't delete it, but it’ll put a pause on all of its automations until you choose to enable it again.

Method 1

  1. Find the pipeline you want to disable.
  2. Click on the three dots ⋮.
  3. Click Disable.
  4. In the pop-up, click Disable.

Method 2

  1. Click on the pipeline you want to disable.
  2. Click the switch next to Pipeline enabled.
  3. In the pop-up, click Disable.

📘

Disabling a pipeline won't undo any actions that have taken place, it will only prevent new actions from being triggered. If there are any actions pending, they’ll be carried out even after disabling.

Enable

There are two ways you can enable a pipeline.

Method 1

  1. Find the pipeline you want to enable.
  2. Click on the three dots ⋮.
  3. Click Enable.
  4. In the pop-up, click Enable.

Method 2

  1. Click on the pipeline you want to enable.
  2. Click the switch next to Pipeline disabled.
  3. In the pop-up, click Enable.

Delete

There are two ways you can delete a pipeline.

Method 1

  1. Find the pipeline you want to delete.
  2. Click on the three dots ⋮.
  3. Click Delete.
  4. In the pop-up, click Delete.

Method 2

  1. Click on the pipeline you want to delete.
  2. Click on Do you want to delete this pipeline?.
  3. In the pop-up, click Delete.

📘

Deleting a pipeline won't undo any actions that have taken place, it will only prevent new actions from being triggered. If there are any actions pending, they’ll be carried out even after deletion.

Search

You can search for your pipelines by name. Simply type in the pipeline name in the search bar and it’ll appear below.

Summary

When you click on a pipeline, you’ll first see its Summary tab where you can conduct all the management actions listed above (See Method 2 for each action). Here, you can also see when the last changes were made and by who.

History

In the History tab, you can review every action that has been carried out by your automation.

The information is laid out with three columns of information: Action, Date and Status.

Action tells you which action was carried out, Date tells you when the action was triggered, and Status tells you the state of the action: Pending, Success, or Fail.

When you click on the action, it’ll expand to show you additional details below based on what action was carried out. Here are the details available for each action type:

  • Webhook – You’ll be able to see the Headers and Payload for both the request and response of this action.
  • Email – You’ll see the email body, within which you can find the event that took place and the project it was triggered by.
  • Custom – You’ll see an event JSON and a context object in the Input tab, and an output JSON, text or traceback in the Output tab.

Headers

Below, you can see a sample header for the webhooks. Please note that the Content-Type is always ”application/json”, and 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"
}

Payloads

You can find a few example payloads below for events and actions.

Item status updated

{
  "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,   
}

Item opened in the editor event

"ip_address",
"action",
"team_id",
"project_id",
"project_name",
"folder_id",
"item_id",
"item_name",
"user_name",
"user_role"

Send email action

  • Event - "Folder status updated"
  • From Value - "{folder_status}"
  • To Value - "{folder_status}"
  • Triggered by - "{team_name/project_name/folder_name}"

Updated 3 days ago