building_custom_forms.md

Building custom forms

Custom forms can include regular field, field groups, and lists which allow to send complex JSON data to the API to process the form.

• Fields allow to send a regular JSON key-value pair: {"field1": "value1"}
• Fields with multiple options allow to send an array of values: {"field1": ["value1", "value2"]}
• Field groups allow to send a nested JSON: {"field1": {"nested_field_1": "value1"}}
• Field groups with multiple option allow to send an array of JSON objects: {"field1": [{"nested_field_1": "value1"}, {"nested_field_1": "value2"}]}

Using custom selectors

Sometimes selector field options should be updated based on a specific form field. For instance, if the state selector field is set to 'Michigan' then only cities from Michigan should be displayed in the cities selector options. Custom selector queries with variables allow to achieve this behavior:

SELECT id as value, name as label FROM cities
{{#state}} WHERE state = {{state}} {{/state}}

Loading form data

It's possible to load initial form data from the API by specified an API endpoint in form settings. Loading initial data is useful for forms which are used for update actions where the existing data should be prefilled and further modified in the form.