Form Data to JSON Policy

Converts form data in the incoming request to JSON.


The configuration shows how to configure the policy in the 'policies.json' document.

{ "name": "my-formdata-to-json-inbound-policy", "policyType": "formdata-to-json-inbound", "handler": { "export": "FormDataToJsonInboundPolicy", "module": "$import(@zuplo/runtime)", "options": { "badRequestIfNotFormData": true } } }

Policy Configuration

  • name <string> - The name of your policy instance. This is used as a reference in your routes.
  • policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be formdata-to-json-inbound.
  • handler.export <string> - The name of the exported type. Value should be FormDataToJsonInboundPolicy.
  • handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
  • handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

  • badRequestIfNotFormData <boolean> -
    Should the policy return an error if the request is not of the type form data.
    Defaults to true.
  • optionalHoneypotName <string> -
    The name of the honeypot field. Used to provide basic spam filtering.

Using the Policy

Read more about how policies work

Change Method