Default Payload

Why and where to use 'default_payload'

The option can be employed in any form requiring the inclusion of data not directly entered by a user during form submission. The request data is processed using Liquid and combined with the request data to create a new or original attribute. A useful example is a slug property formatted based on the title or name property.

Another key attribute of is its ability to enable the server-side modification or extension of user input. This feature can be utilized, for instance, to save references or compute prices, as users cannot alter its value maliciously, even if they attempt to edit a form's HTML.

Form variable

Liquid Template provides a variable populated with various properties useful when dealing with forms.

Example

Default Payload can help set action timestamps, states, or modification of request state. In the example below, the custom property is set with each form submission:

---
...
fields:
  properties:
    cancelled_at:
      validation:
        presence: true
default_payload: |-
  {%- assign date_now = 'now' | date: '%d-%m-%Y %H:%M:%S' -%}
  {
    "properties_attributes": {
      "cancelled_at": "{{ date_now }}"
    }
  }
---

Record example

Here is another example demonstrating the use of default payloads:

---
...
fields:
  properties:
    some_custom_property:
      validation:
        presence: true
default_payload: |-
  {
    "properties_attributes": {
      "some_custom_property": "New value for this property"
    }
  }
---