Overview

1. Saves time and effort for respondents by pre-filling form fields.
   
2. Improves data accuracy by reducing manual data entry errors.
   
3. Creates a personalized experience for respondents.

1. Once you have your form built, in your form builder, navigate to the Settings tab >Prefill > Dynamic Prefill - Webhooks.
   
   
   
   
2. Click Configure.
   

1. Webhook Settings

Search Configuration

Search Field: The Search Field will be the form field which will be used to retrieve related information from an external service. Select a form field from the dropdown as the Search Field.
The following form fields can be selected as search fields:
Single Line, Email, Phone, Dropdown, Radio, Number

Note:

1. When a user clicks the search icon next to the Search Field in the live form, the webhook is triggered and the response is prefilled in the form. 
   
2. When a form loads with a pre-filled value (via Field Alias) in the search field, it triggers the search.

Webhook Details

1. Webhook URL: The Webhook URL is the endpoint where your form will send requests to the external service on search. Enter the full URL of the external service to retrieve the data.
   
2. Record Identifier Key: The Record Identifier Key is used as a query parameter to send the value in the Search Field to the external service.
   During a record search, the webhook will include the Record Identifier Key as a query parameter. The value of the Search Field will be sent as the query parameter value.
   Based on the value in the Record Identifier Key, the external service provides the data to be prefilled in the form.
   Example:
   For example, if your Search Field is " Enter your Email", the Record Identifier Key is email, when a user enters the value in the Search Field as richard@zylker.com and searches, the webhook will send a request like https://api.zylker.com/getEmpInfo?email=richard@zylker.com
   
3. URL Parameters: If you would like to send additional information along with the Webhook request, you can specify it in this section. For example, you can include a secret key to every request being sent. This would help you in filtering out authenticate requests. These parameters will be added as query strings to the URL. Click on Add Parameters and enter the parameter name, value in the text boxes provided.
   
4. Custom Headers: You can set a custom header name and value to be passed with the Webhook request. Enter the name of the header and the value associated with this header.

Note: You can add upto 5 URL Parameters and Custom Headers each.

2. Webhook Testing

In this step, you can test the webhook to ensure it retrieves the correct data based on the value entered in the Search Field.

1. Enter a sample value in place of <Search Field's value> and run the test to send the request to the external service.
   For example, if your Record Identifier Key is email, enter a test email address (richard@zylker.com). 
2. Click Run Test. This triggers the form to send a test request to the external service using the provided test value (richard@zylker.com).
   https://api.zylker.com/getEmpInfo?email=richard@zylker.com
   
3. It is checked if the format of the response received is valid. You will be able to proceed to the next step only if the received response is valid.
   
   
   
   

3.  Prefill Mapping

The next step is to determine which form fields should be pre-populated with the information from the fetched data.

To map the form fields that you wish to prefill with data from the external service, 

1. Add a form field and click the field corresponding to it.
   
   
   A popup with the JSON response will open. Identify the keys in the JSON response that contain the data you need and select it for the mapping.
   
   
   
   Repeat this for all the form fields that you wish to prefill.
   
   
   
   
2. If you have any Subform field in your form, and wish to prefill them, map those Subform fields with the corresponding external service data fields in the same way.

Note: You can have a maximum of 50 field mappings, including fields mapped within the subform.

Response Formats for the Field Types

Check out the Response formats corresponding to the form fields.

Field Type	Example	Response Format
Single Line, Multi Line, Address, Name, Dropdown, Radio	Richard
Number, Rating, Slider	100
Currency, Decimal	100.5
Email	richard@zylker.com
Website	www.zylker.com
Phone	2436673893
Date	2024-08-23	yyyy-MM-dd
Time	14:30	HH:mm
Date-Time	2024-12-30T10:05:59.564600+08:00	yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Checkbox, Multiple Choice, Image Choices	[100.50, 101.50]	JSON Array
Decision Box	TRUE
Subform	[ { <SUBFORM_ROW_1> }, { <SUBFORM_ROW_2> } ]	JSON Array

Note: 

1. This is the total limit for your organization's account, including all users and forms.
   
2. You can view your usage details under Account Usage.
   
3. Once the limit is reached, the access to the form will be blocked.
4. The Dynamic Prefill - Webhook feature is not available in the Free plan.
   
5. The limit will be reset automatically every month based on your billing cycle.