Workflows
The Workflows API is in beta at present. Please contact Trelica first if you want to use these endpoints.

Workflows and runs

A workflow describes a series of steps to be followed.
A workflow run is generated every time a workflow is triggered. This can either be on a schedule (e.g. once a day), or in response to a particular event occurring.
In a simple workflow, a sequence of steps is executed one after the other.
Step 1 ->
Step 2
-> Step 3
Each step can either end up Completed, Failed, or Waiting. If a step fails, then the workflow run ends.
An additional level of complexity means that steps can be grouped, and run in parallel. The workflow will only move to Step 4 once both Steps 2 and 3 complete:
Step 1 ->
Step 2
Step 3
-> Step 4
Finally, steps can be run inside loops. In this example Step 2 might be repeated several times. Each run of Step 2 is called an Iteration.
Step 1 ->
Step 2
Step 2
Step 2
-> Step 3

Workflow contexts

Each time a workflow run is triggered, data relating to the event that caused the workflow to run is stored in a so-called context.
If a new application is discovered for example, the context will contain the unique ID and name of the application.
As a workflow run progresses, the context may change. For example, if a new user is created in your identity provider, then the corresponding email address will get set in the context for other workflow steps to access and use.
The context will also change inside a loop, according to whatever you are looping over.
Last modified 9mo ago
Copy link
Outline
Workflows and runs
Workflow contexts