Skip to content

Defining workflows

Workflows are defined by directed graphs described in JSON syntax.

{
    "start": {
        "step": {
            // step paths definition
        }, 
        "behaviors": {
            // client behavior
        },
        "actions": {
            // server behavior
        },
        // ... step
    },
    [step name]: {
        // step
    }
}

Step definition

  • name: appears as a small tag
  • template: initial string for entry
  • description
  • scope: query string | $sink | $source | $all
  • paths:
    • label
    • step
    • behavior
    • icon
  • status: active | retired
  • nameStyle: danger | success | info | dark | warning

Behaviors

  • handle
  • behavior: dispatch
  • target: query string | $sink | $source | $all
  • fields: parameter for the behavior
  • data: JSON for the behavior

Actions

  • action: see below
  • scope: query string | $sink | $source | $all
  • args: parameter for the action

Possible actions

  1. status - change status for scope users
  2. task - update dispatch task status
  3. lock, unlock - lock and unlock the entry
  4. script - execute script
  5. notify - send push notification
  6. trigger - trigger a new rule step
  7. chat (BETA)