ZUzuper

Get Workflow Details

Changed on

Returns full workflow details. Pass should_populate=true to resolve condition/action reference values (e.g. category, status, team, user) to populated objects instead of raw uids.

get/workflow/{workflow_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/workflow/{workflow_uid}
  • Auth
    API key in header x-api-key

Path parameters

workflow_uidstring required

Query parameters

should_populateboolean

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "workflow_name": "Rquest note",
    "workflow_description": "Rquest note",
    "workflow_uid": "f7abcbba-113f-4344-9b2e-952c02149e75",
    "trigger_module": "REQUEST",
    "workflow_access": "COMPANY_WIDE",
    "trigger_event": "request.new_note",
    "trigger_event_name": "Request New Note",
    "actions": [
      {
        "action_type": "UPDATE",
        "action_module": "REQUEST",
        "field_type": "DEFAULT",
        "field_value": "customer_email",
        "display_name": "Send Email to Customer",
        "custom_values": [
          {
            "label": "email_subject",
            "value": "New comment added for {{request_title}}",
            "_id": "66975feb98926b644acca7d3"
          }
        ],
        "change_value": "New comment added for {{request_title}}",
        "type_of_operation": {
          "label": "Send Notifications",
          "value": "OTHERS"
        },
        "_id": "66975feb98926b644acca7d2"
      }
    ],
    "created_by": {
      "user_uid": "b9c91ee7-850f-47b7-b2cd-a6b78f4254d3",
      "first_name": "Tom",
      "last_name": "R",
      "email": "tom.r@zuper.co",
      "home_phone_number": "9898989898",
      "designation": "Admin",
      "emp_code": "001",
      "work_phone_number": "9898989898",
      "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/4ddf323f-19ed-4b56-81cc-70bdf628c5/ea2602d9-0379-4ffb-a2c0-916dc2558c56.JPG",
      "is_active": 1,
      "created_at": "2024-06-14T07:34:28.000Z",
      "updated_at": "2024-09-18T04:03:31.000Z"
    },
    "allow_workflow_to_trigger": true,
    "is_active": true,
    "created_at": "2024-07-17T06:08:43.957Z",
    "updated_at": "2024-07-17T06:08:43.974Z"
  }
}

Changes