Skip to content

Workflow Steps

Entity workflows can have multiple steps.

  • key: string used to define the step key
  • name: string used to define the step label in the UI
  • position
    • x: x-axis
    • y: y-axis
  • ownershipDetails: specify who is the owner of the step. It will be used to send notifications
    • userGroups: array of codes from the native user_group entity
    • userFields: array of related fields with the native user and/or user_group entity

Example

{
  "steps": [
    {
      "key": "initial",
      "name": "Initial",
      "order": 1,
      "position": {
        "x": 50,
        "y": 0
      },
      "ownershipDetails": {
        "userGroups": [],
        "userFields": ["user_id", "user_group_id"]
      }
    },
    {
      "key": "final",
      "name": "final",
      "order": 2,
      "position": {
        "x": 100,
        "y": 0
      },
      "ownershipDetails": {
        "userGroups": [],
        "userFields": ["user_id", "user_group_id"]
      }
    }
  ]
}