Introduction
Flowingly provides an API through which step field values can be saved/updated. This provides Flowingly customers an option to integrate third party systems with Flowingly.
API
Flowingly API to update step fields is available at the following url:
1 HTTP POST {baseurl}/public/flow/{flowIdentifier}/step/{stepIdentifier}
{flowIdentifier} - Flow Identifier to uniquely identify such as FLOW-12345.
{stepIdentifier} - Name of the step in a flow as defined in Modeler.
For example:
https://publicapi.flowingly.net/public/flow/FLOW-604/step/New Customer (Debtor) Form
Process
The API upon receiving the request first authorizes the request with access token in Authorization header. Once request is authorized then request payload model and field values are validated. Then the step field values are updated. Following diagram depicts this process.
Supported Field Types
Following table list outs field type currently supported for update via API and their example values.
Validation
Each field is validated against the rule configured via modeler. If the validation rule set contains any custom error message then those are used by the api when returning validation error response. If no such custom error message is set then an appropriate default validation error response is returned.
Field Type | Example Value | Notes |
Short Text |
| In this example, value for field |
Long Text |
| In this example, value for field |
Dropdown List/Single Select List |
| In this example, value for this field Model: Value for this field must match the model in the example. The first 10,000 options available for this field are returned in the HTTP GET api. To set a value for this field the “isSelected” property must be set to true. |
Option List |
| In this example, the value selected for field Model: Value for this field must match the model in the example. The first 10,000 options available for this field are returned in the HTTP GET api. To set a value for this field the “isSelected” property must be set to true. |
Check Box |
| In this example, the field To mark this field as check “true“ must be passed in and “false” to un-check. |
Multi-selection List |
| In this example, field
Model: Value for this field must match the model in the example. The first 10,000 options available for this field are returned in the HTTP GET api. To set values for this field the “isSelected” property must be set to true for each option. To unset any previously set field “isSelected” property must be set as false. |
| In this example, value for field Value must be in a valid email format. | |
Date |
| In this example, value for field Value must be in the format: "dd/MM/yyyy" Only Custom Value validation rule is processed other Custom Validation rules Step Created Date and Previous Field Value are not processed. However these are processed in Runner. |
DateTime |
| In this example, value for field Value must be in the format: "dd/MM/yyyy hh:mm:ss tt" Only Custom Value validation rule is processed other Custom Validation rule Previous Field Value are not processed. However these are processed in Runner. |
Currency |
| In this example, value for field This field has a maximum allowed length of 15 Only Custom Value validation rule is processed other Custom Validation rule Previous Field Value are not processed. However these are processed in Runner. |
Number |
| In this example, value for field This field has a maximum allowed length of 15 Only Custom Value validation rule is processed other Custom Validation rule Previous Field Value are not processed. However these are processed in Runner. |