The external element ID used in the 'conditionally show option' process
An array of option IDs associated with an individual option
An array of option attributes associated with an individual option.
The color of the button used to display the option, if the element has
buttons configured as true.
For autocomplete elements this option will always appear in the search results.
The label displayed to the user for an individual option.
An array of nested options, relevant to the option.
The value for an individual option, sent with form submission data.
The label to display in the forms builder when selecting an element to match the "value" property. E.g. if this options set is for Cities (Sydney, Brisbane, Melbourne) and the parent options set is for States (NSW, QLD, VIC), this label could be "State".
The value of the parent form element option to filter this option. E.g. E.g. if this options set is for Cities (Sydney, Brisbane, Melbourne) and the parent options set is for States (NSW, QLD, VIC) and this option represented Sydney, this value would be "NSW".
The attribute from the dynamic options set to be mapped to the option element ID.
The ID of the option value for the attribute to be mapped to.
The text that will be displayed based on hintPosition
Determine where the helper text will show
Must match a "FormElement.name" property exactly to pre-fill with the "preFillValue".
The pre-fill data to inject into the form when the "inputValue" matches exactly what the user has entered or selected when completing the form.
Allow the user to select an item after being filter down via category and sub-category
{
"id": "b1311ae0-6bb7-11e9-a923-1681be663d3e",
"type": "freshdeskDependentField",
"name": "country_state_suburb",
"label": "Country",
"hint": "Please select a Country before selecting a State.",
"subCategoryLabel": "State",
"subCategoryHint": "Please select a State before selecting a Suburb.",
"itemLabel": "Suburb",
"itemHint": "Please select a Suburb.",
"defaultValue": {
"category": "Australia",
"subCategory": "NSW",
"item": "Sydney"
},
"required": true,
"readOnly": false
}
{
"submission": {
"[element.name]": {
"category": "Australia",
"subCategory": "NSW",
"item": "Sydney"
}
}
}
A top level value selected e.g. Country
A final level value selected e.g. Suburb
A second level value selected e.g. State
Configuration options that affect the whole approval flow
The identifier for the email template to use when notifying approvers of a new approval to action
A list of canned responses available for the form that can be assigned when approving an approval
The identifier for the email template to use when notifying the user that submitted the form that an approver has approved their submission
Configuration for automatically denying an approval after a number of
days when a clarification request has been sent with no response. Set
undefined or unset for no Auto Deny.
The amount of days after a clarification request has been sent with no response until the approval is automatically denied.
Internal notes that are not seen by the user that submitted the form
Key to associate a canned response with an approval to allow for reporting
Notes sent to specified users
The email addresses of the users to be notified of the result. If the
approval flow has a defaultNotificationEmailElementId configured,
this address will also receive a notification email.
A list of canned responses available for the form that can be assigned when requesting clarification
The identifier for the email template to use when notifying the user that submitted the form that an approver has requested clarification
The id of the element to use as a default prefill for the notification email address when actioning an approval for this form
Allow a default value for the preventPayment flag when approvers are
requesting clarification
The identifier for the email template to use when notifying the user that submitted the form that an approver has denied their submission
A list of canned responses available for the form that can be assigned when denying an approval
Disallow approving when approval is waiting for clarification
Configuration for sending recurring reminders at an interval of days to Approvers of pending approvals for this form.
The amount of days that an approval must be overdue before sending daily reminders
Whether or not viewing the form should auto-continue with autosave data when available rather than prompting the user
Custom CSS classes that will be added to the form during rendering
A description of the form.
All elements contained within the form itself.
The details of the externalId generation endpoint which will be executed after "serverValidation" but before submission.
The forms app environment ID the form belong to.
ID's of any Forms Apps that the form is included in.
Whether or not the form can only be viewed by an Authenticated user.
Whether or not the form contains multiple pages.
Name of the form.
The organisation ID the form belong to.
The details of the personalisation endpoint which will be executed on form load to prefill existing elements or return a new set of elements.
The action for the Form to take on a successful submission.
Configuration to customise the display after a successful submission.
Whether or not to generate a token to allow downloading the form submission PDF after a successful submission.
HTML to display instead of the default "Thank you" message after a successful submission.
The date and time (in ISO format) a form becomes unavailable.
The date and time (in ISO format) a form becomes available.
The URL the form will redirect to if configured to do so by the
postSubmissionActions.
The details of the form validation endpoint.
Events that occur/trigger on a valid successful submission.
The title of a form submission, supports element injection
A list of tags used to categorise or describe the form.
The message to be shown to forms users when the form is not in the published time window
The id of the key
The name of the key
The user that last updated the form
A human readable identifier for the Lookup.
The identifier for the organisation associated with the Lookup.
Determine if the element is conditionally shown (true) or not (false).
Predicates to evaluate.
Custom CSS classes that will be added to the element during rendering
The unique identifier for an individual form element.
JSON metadata associated with the form element. This field is for primarily for developer use.
Determine if the predicates must all match (true) or if only one needs to
match (false) for the element to shown.
Allow the user to enter a valid ABN (as per https://abr.business.gov.au/).
Example
Example Submission Data