Web Form Workflow Actions

New Web Form

How to Create a New Web Form

New Web Form from JSON

This action allows you to create a Web Form using a JSON Schema.

note

If you do not want to include the key-value pair in your Web Form, set the value to and empty string or an empty array if it requires options.

Keep in mind that even though certain parameters like options_type, free_text_regex, filtering_field, and enforce_connection_types are always set to either an empty string ("") or null, they still need to be included in the JSON schema for the Web Form actions to work properly. This inclusion is necessary for the actions to execute smoothly, even though these parameters aren't actively used.

Each Key-Object pair require the following :

Parameter	Data Type	Description
label	Text	The Labels for the fields on the form.
required	Boolean	Set to True if the form field is required to be filled out, and set to False if it is optional.
type	Input Types	Text, Number, Date&Time, MultiSelect, SingleSelect and Checkbox
default	Boolean	Sets to True to set the value as the default value or false to set it as the default value
placeholder	String	Temporary text displayed within an empty input field to indicate the type of information that should be entered
options	Array	Labels for the options you want to include in the MultiSelect menu.
display_name	String	Generates a new label name for the field on the form by overriding the default label.
allow_free_text	Boolean	Set to True if you want to allow free text in dropdown menus or false to not allow it.
index	Number	The index is used to determine the order in which you want to arrange your form fields.
options_type	Empty String	Always set it as an empty string: "".
free_text_regex	Empty String	Always set it as an empty string: "".
filtering_field	Empty String	Always set it as an empty string: "".
enforce_connection_types	null	Always set it as null.

JSON Schema Example:

{
  "Text": {
    "required": false,
    "type": "text",
    "default": false,
    "placeholder": "Name",
    "options": [],
    "display_name": "",
    "options_type": "",
    "allow_free_text": false,
    "free_text_regex": "",
    "index": 1,
    "filtering_field": "",
    "enforce_connection_types": null
  },
  "Number": {
    "required": false,
    "type": "number",
    "default": "",
    "placeholder": "age",
    "options": [],
    "display_name": "",
    "options_type": "",
    "allow_free_text": false,
    "free_text_regex": "",
    "index": 3,
    "filtering_field": "",
    "enforce_connection_types": null
  },
  "Date&Time": {
    "required": false,
    "type": "date",
    "default": "",
    "placeholder": "",
    "options": [],
    "display_name": "",
    "options_type": "",
    "allow_free_text": false,
    "free_text_regex": "",
    "index": 4,
    "filtering_field": "",
    "enforce_connection_types": null
  },
  "Checkbox": {
    "required": false,
    "type": "checkbox",
    "default": false,
    "placeholder": "",
    "options": [],
    "display_name": "",
    "options_type": "",
    "allow_free_text": false,
    "free_text_regex": "",
    "index": 5,
    "filtering_field": "",
    "enforce_connection_types": null
  },
  "MultiSelect": {
    "required": false,
    "type": "multi-select",
    "default": "",
    "placeholder": "",
    "options": ["a", "b", "c", "d"],
    "display_name": "",
    "options_type": "static",
    "allow_free_text": false,
    "free_text_regex": "",
    "index": 7,
    "filtering_field": "",
    "enforce_connection_types": null
  },
  "SingleSelect": {
    "required": false,
    "type": "single-select",
    "default": "",
    "placeholder": "",
    "options": ["1", "2", "3"],
    "display_name": "",
    "options_type": "static",
    "allow_free_text": false,
    "free_text_regex": "",
    "index": 4,
    "filtering_field": "",
    "enforce_connection_types": null
  }
}

How to Create a New Web Form from JSON

Wait For Web Form Response

How to Create a Wait For Web Form Response

The Wait For Web Form Response action is required to be used alongside either New Web Form action or a New Web Form from JSON action.

note

Please remember that this step can only wait for a reply from one form, and each form can only be submitted once.

Additionally, keep in mind that the timeout field is optional. You can set a custom timeout to end the Wait For Web Form Response step. If you don't specify a custom timeout, it will default to the automation's maximum time limit, which is 2 hours.