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.  Prefill Mapping

1. Map the form fields that you want to prefill with data from the external service.
2. Identify the keys in the JSON response that contain the data you need and enter the JSON key next to the corresponding form field for the mapping.
   For example, If the JSON response contains "name": "Richard Johnson", enter name as the JSON key.
3. 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.
   
4. Click Next.
   

3. Test & Save

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 matches the expected format. 
   
   
   
   
4. Once verified, you can proceed to save the configuration.

Response Formats for the Field Types

[
  {
    "columnname": "Answer A",
    "value": "Option 1"
  },
  {
    "columnname": "Answer B",
    "value": "Option 2"
  }
]

[
  {
    "columnname": "Answer A",
    "value": "100"
  },
  {
    "columnname": "Answer B",
    "value": "100"
  }
]

[
  {
    "columnname": "Answer A",
    "value": "10.50"
  },
  {
    "columnname": "Answer B",
    "value": "20.60"
  }
]

[
  {
    <SUBFORM_ROW_1>
  },
  {
    <SUBFORM_ROW_2>
  }
]

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.