Work Flow
Work flows consist of processes.
Work Flow Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work flows's id |
| organisation_id | snowflake | the id of the organisation |
Work Flow Revision Object
Work Flow Process
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work flows process' id |
| role_id | snowflake | the role required to complete a process |
| type | [process type] | The type of success flow |
| success | snowflake | the process to complete on success |
| failure | snowflake | the process to complete on failure |
| function | string | a function to perform |
| parameters | object | an object of parameters to feed into the function |
assigned_to | user | the user the process step has been assigned to
Work Flow Process Type
| Name | Value | Description |
|---|---|---|
| manual | 0x0000 | Manually complete the process, such as an approval |
| automatic | 0x0001 | Automatically complete the process when a condition is met |
Create Work Flow
POST /organisations/{organisation.id}/workflows