Overview

The Workflow Management REST APIs allow the creation of a workflow, and steps within the workflow. Steps, and split step options must be assigned actions that are already defined through the Enrollment Actions API. Please see that API for additional information. For split steps only the action definition is to be provided, but the options require a matching action type, and must be of type split.

Getting Started: Creating Workflows and Steps

1. Create a Workflow

To create a new workflow:

1. Use POST /workflows with required fields: name, description
2. Optionally specify allowedIps and disAllowedIps for network restrictions
3. The workflow will be created with a status of work in progress
4. Use PATCH /workflows/{workflowId} to update workflow properties

2. Create Steps

Steps define the user journey within a workflow:

1. Start Step: Use POST /workflows/{workflowId}/steps to create the initial step
2. Regular Steps: Create additional steps using POST /workflows/{workflowId}/steps/{stepId}
3. Split Steps: Create branching logic using split steps with multiple options
4. End Steps: Mark steps as terminating to end the workflow

3. Assign Actions to Steps

Each step requires an action definition:

1. Query available actions using GET /workflowActionDefinitions
2. Assign action by setting actionDefinitionId in the step
3. For split steps, create options using POST /workflows/{workflowId}/steps/{stepId}/splitOptions
4. Each split option must have a matching action type

4. Connect Steps in Sequence

Link steps together to create the workflow flow:

1. Set nextStepId to connect steps in sequence
2. Use POST /workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId} to attach steps
3. For split steps, each option can lead to different next steps

5. Publish the Workflow

Make the workflow available to users:

1. Use PATCH /workflows/{workflowId} with publishedDetails.status: 'PUBLISHED'
2. The workflow must be valid before publishing
3. Published workflows can be assigned to captive portal networks