Web Form Request

A Web Form Request generates a private request link for a Web Form. It allows users to access and submit a form without making it publicly available, making it ideal for invitation-based workflows and secure data collection.

Tip:

Use Web Form Requests when you want respondents to access a form through a secure link instead of exposing it publicly.

When to Use a Web Form Request

A Web Form Request is useful when:

The respondent should access the form through a private link.
The respondent does not have a user account.
The form should include respondent-specific information.
Some document values should remain hidden from the browser.

Common use cases include customer satisfaction surveys, event invitations, feedback forms, and personalized registration links.

Creating a Web Form Request

Create a new Web Form Request and select the Web Form it belongs to. A unique, URL-safe request key is generated automatically.

Each request can include the following settings:

Expires On – Specifies the date and time after which the request link becomes invalid.
Web Form Values – JSON values that are pre-filled in the Web Form and remain editable by the respondent.
Doc Values – JSON values applied to the created document without being exposed to the browser.

Best Practice:

Use Web Form Values for information users should see, and Doc Values for internal fields that should remain hidden.

Request URL

The generated request key is included in the Web Form URL as a query parameter.

/your-web-form-route/new?web_form_request_key=<key>

You can copy this URL directly from the Web Form Request document and share it with respondents.

Require a Request Key

Enable the Key Required option in the Web Form to ensure that only users with a valid request key can access the form.

Note:

If Key Required is enabled and no valid request key is provided, the Web Form cannot be opened or submitted.

If Login Required is also enabled, users must both:

Be logged in.
Provide a valid request key.

Pre-filled and Hidden Values

Web Form Values

Use Web Form Values to pre-fill fields that are visible to respondents.

These fields must exist in the Web Form’s field list and remain editable unless restricted by other settings.

Doc Values

Use Doc Values to populate document fields that should not appear on the Web Form.

These values are applied during document creation but are never sent to the user’s browser.

JSON keys must match the underlying field names defined in the target DocType.

Example:

{
    "customer": "CUST-0001",
    "survey_source": "Partner CSAT"
}

Expiry and Usage

Request Expiry

If an Expires On date is specified, the request key becomes unusable after the configured date and time.

Single Response Forms

For Web Forms that allow only one response, the request is marked as used after a successful submission.

The request is then linked to the created document, allowing users to reopen, edit, or delete the response if those options are enabled.

Multiple Response Forms

If Allow Multiple Responses is enabled, the same request key can be reused for multiple submissions.

In this mode, the request is not linked to a single document because multiple records may be created.

Tip:

Use reusable request keys for recurring surveys or feedback forms where respondents may need to submit multiple responses.

Related Web Form Settings

Allow Multiple Responses

When enabled, a single request key can be used to submit multiple responses.

Note:

When multiple responses are allowed, the Web Form Request cannot have a Reference Docname because one request may create multiple documents.

Allow Editing After Submit

Allows users to reopen and edit responses associated with their request key after submission.

Allow Delete

Allows users to delete responses associated with their request key, provided deletion is permitted by the Web Form settings.

Rating: 0 / 5 (0 votes)