Skip to main content

Web Form Workflow Actions

New Web Form

How to Create a New Web Form

  1. Create a step by searching "Web Form" in the search bar and select the "New Web Form" action.
Thumbnail
  1. Enter a header for your Web Form. If you wish to use a custom logo, check the box, provide the URL for the logo, and optionally add a short description for the Web Form.
Thumbnail
  1. To add input fields to your Web form, click on the "Add Field" option. Provide a label name and choose input type. Additionally, you can customize how this input parameter appears in the form by choosing the "Configure how this input parameter looks in the input form" option.
Thumbnail
  1. Enter the text you want displayed on your button.
Thumbnail
  1. Advanced > Access control hierarchy Choose who can access and interact with the Web Form:
    • Anyone in this tenant: Anyone signed into the tenant can access the form. This is the default option.
    • Anyone in this workspace: Only signed-in members of the specific workspace where the web-from was created, can access the form.
    • Anyone with link (public): Anyone with the form URL link can access and interact with it.
    • Anyone in the organization (SSO): Non-Blink user can access and interact with the form using their organization's SSO.
Thumbnail
  1. Click the Thumbnail icon to execute this step. You will recieve the Web Form Link in the step's output.
Thumbnail
  1. Click on the link and you will be re-directed to the newly created Web Form.
Thumbnail

Interactive Tutorial Guides- How to Create a New Web Form

You can also refer to the following tutorial guides for a more in-depth understanding of how to create a New Web form.

New Web Form from JSON

How to Create a New Web Form from JSON

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

  1. Create a step by searching "Web Form (JSON)" in the search bar and select the "New Web Form(JSON)" action.
Thumbnail
  1. Enter a header for your Web Form.
Thumbnail
  1. Add inputs for your Web Form in JSON format.
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 :

ParameterData TypeDescription
labelTextThe Labels for the fields on the form.
requiredBooleanSet to True if the form field is required to be filled out, and set to False if it is optional.
typeInput TypesText, Number, Date&Time, MultiSelect, SingleSelect and Checkbox
defaultBooleanSets to True to set the value as the default value or false to set it as the default value
placeholderStringTemporary text displayed within an empty input field to indicate the type of information that should be entered
optionsArrayLabels for the options you want to include in the MultiSelect menu.
display_nameStringGenerates a new label name for the field on the form by overriding the default label.
allow_free_textBooleanSet to True if you want to allow free text in dropdown menus or false to not allow it.
indexNumberThe index is used to determine the order in which you want to arrange your form fields.
options_typeEmpty StringAlways set it as an empty string: "".
free_text_regexEmpty StringAlways set it as an empty string: "".
filtering_fieldEmpty StringAlways set it as an empty string: "".
enforce_connection_typesnullAlways 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
}
}
  1. If you wish to use a custom logo, check the box, provide the URL for the logo, optionally add a short description for the Web Form and enter the text you want displayed on your button.
Thumbnail
  1. Advanced > Access control hierarchy Choose who can access and interact with the Web Form:
    • Anyone in this tenant: Anyone signed into the tenant can access the form.This is the default option.
    • Anyone in this workspace: Only signed-in members of the specific workspace where the web-from was created, can access the form.
    • Anyone with link (public): Anyone with the form URL link can access and interact with it.
    • Anyone in the organization (SSO): Non-Blink user can access and interact with the form using their organization's SSO.
Thumbnail
  1. Choose either the "Light Mode" color theme or "Dark Mode" color theme for the appearance of the Web Form
Thumbnail
  1. Click the Thumbnail icon to execute this step. You will recieve the Web Form Link in the step's output.
Thumbnail
  1. Click on the link and you will be re-directed to the newly created Web Form.
Thumbnail

Interactive Tutorial Guides- How to Create a New Web Form from JSON

You can also refer to the following tutorial guides for a more in-depth understanding of how to create a New Web form using JSON format.

Wait For Web Form Response Action

note

The "Wait For Web Form Response Action" will have a maximum timeout of 14 days. For more information please visit the Workflows Runtime Limitations section of our documentation.

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 Workflow's maximum time limit, which is 2 hours.

  1. Create a step by searching "Web Form (JSON)" in the search bar and select the "Wait For Web Form Response" action.
Thumbnail
  1. Enter the Web Form URL received in the previous steps that you want to recieve the response from.

  2. Configure the Advanced settings by optionally adding:

    • Timeout- You can set a time out to end the wait for a response from the Web Form.
    • Time Unit- Choose a time unit- Seconds, minutes or hours.
Thumbnail
  1. Click the General Settings icon to execute this step. You will recieve the details of the response entered from in the Web Form in the step's output.
Thumbnail

Interactive Tutorial Guides- How to Create a Wait For Web Form Response

You can also refer to the following tutorial guides for a more in-depth understanding of how to create a Wait For Web Form Response action.