Links

Workflows

get
https://app.trelica.com/api/
workflows/v1
List workflows

Simple queries

The q parameter lets you pass a simple text query. This searches the follow fields:
Field value matches query exactly
Field value contains query text
Workflow ID
Workflow name

Example filters

Filter
Results
name eq "onboarding workflow"
Returns the workflow called "Onboarding Workflow"
name sw "contr"
Workflows with a name starting with "contr", e.g. "Contractor offboarding"
trigger[type eq "PersonFilter"]
Workflows triggered based on a person filter
lastModifiedDtm ge "2022-01-01"
All workflows modified after 1st Jan 2022

Data structure

Workflow

Attribute
Type
Description
id
string
Unique identifier for workflow
name
string
Workflow name
enabled
boolean
True if the workflow is set to run; false if it's deactivated
trigger
object
Trigger object
createdBy
object
Compact User object
createdDtm
datetime
(ISO format) Date/time created
lastModifiedBy
object
Compact User object
lastModifiedDtm
datetime
(ISO format) Date/time last modified
steps
array
List of Step objects

Trigger

Attribute
Type
Description
id
string
Unique identifier for trigger
name
string
Name of trigger
type
string
AppDiscovered | AppUserFilter | PersonFilter | TaskCreated | Schedule
startDate
date
Earliest date that the workflow will run.
hour
number
Time of day (UTC) that the trigger will run (0 -> 23)
period
enum
Period for the frequency at which the schedule will run.
Day | Week
everyNPeriods
number
Frequency at which the schedule will run.
dayOfWeek
enum
(Only valid if the period is set to Week)
Mon | Tue | Wed | Thu | Fri | Sat | Sun

Step

Attribute
Type
Description
id
string
Unique identifier for step
type
enum
name
string
Step name

Step types

Value
Description
AppCondition
Branch based on a condition relating to an application.
CreateExternalTask
Create a task in a third-party application.
CreateTask
Create a Trelica task.
Delay
Wait for a period of time.
Deprovision
Remove a user account in a third-party application.
FilterApps
Return a list of applications based on a condition.
FilterAppUsers
Return a list of application users based on a condition.
Finish
Terminate the workflow
ForEachApp
Loop over a list of applications
Join
Join (after a split).
PersonCondition
Branch based on a condition relating to a person.
Provision
Create a user account in a third-party application.
SendEmail
Send an email.
SetAppStatus
Set the status of an application in Trelica.
Split
Split a workflow into parallel paths.
TaskCondition
Branch based on a condition relating to a task.
Wait
Wait for a period of time, or until an external action signal is received.