Last edit: Oct 26, 2022

No description

type FormConfigurationInputType {
  async_callback_actions: String
  async_callback_delay: String
  async_callback_max_attempts: Int
  async_callback_priority: AsyncCallbackPriority
  authorization_policy_ids: [ID]
  callback_actions: String
  configuration: HashObject
  default_payload: String
  flash_alert: String
  flash_notice: String
  liquid_body: String
  metadata: HashObject
  name: String
  physical_file_path: String!
  redirect_to: String
  resource: String!
  resource_owner: String!
  spam_protection: SpamProtectionInputType


async_callback_actions (String)

Same as callback, but invoked asynchronously. Recommended for performance reason.

async_callback_delay (String)

liquid code which should evaluate to float. Delays invoking the job by
specified number of minutes. Useful to invoke code at certain point in time,
for example 1 hour before something etc. To calculate proper number you can
use time_diff filter.

async_callback_max_attempts (Int)

Defines max number of retrying attempts in case of an error. Usually you do not want to change it.

async_callback_priority (AsyncCallbackPriority)

defines the invocaction priority, the higher the quicker timeout

authorization_policy_ids (ID)

ids of authorization policies which should be checked

callback_actions (String)

liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead

configuration (HashObject)

whitelist of attributes which can be persisted in the DB. On server side
(callbacks, emails etc) you have access to submited values via form variable
(for exapmple configuration: properties: my_var is accessible via
form.properties.my_var )

default_payload (String)

liquid code which has to evaluate to JSON. This extends/overwrites user
submitted input via form, before validation. Most useful to store in DB
sensitive data which you do not want user to modify, for example

flash_alert (String)

liquid code which should evaluate to message which you want to display to user
upon validation errors. Output is available via context.flash_alert

flash_notice (String)

liquid code which should evaluate to message which you want to display to user
after successful form submission. Output is available via context.flash_notice

liquid_body (String)

liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.

metadata (HashObject)

name (String)

physical_file_path (String)

defines where the file definition will be available after pull; should start
with the module name follow by private/public scope, for example

redirect_to (String)

liquid code which should evaluate to valid path or url to which user should be
redirected after successful form submission.

resource (String)

resource_owner (String)

defines who can submit the form. If set to anyone, please make sure to provide authorization_policies

spam_protection (SpamProtectionInputType)

strategy to protect against spam attacks.

Contribute to this page

Github Icon


We are always happy to help with any questions you may have.

contact us