FormConfiguration

Form (app/forms). Deprecated, use Form instead

type FormConfiguration implements AdminSharedAttributesInterface {
  api_call_notifications: [ApiCallNotification!]
  async_callback_actions: String
  async_callback_delay: String
  async_callback_max_attempts: Int
  async_callback_priority: AsyncCallbackPriority
  authorization_policies: [AuthorizationPolicy!]
  callback_actions: String
  configuration: HashObject
  created_at: JSONDate!
  default_payload: String
  email_notifications: [EmailNotification!]
  flash_alert: String
  flash_notice: String
  id: ID!
  liquid_body: String
  manually_managed: Boolean
  metadata: HashObject
  name: String!
  physical_file_path: String
  redirect_to: String
  resource: String!
  resource_owner: String!
  sms_notifications: [SmsNotification!]
  spam_protection: HashObject
  updated_at: JSONDate!
}

Fields

api_call_notifications (ApiCallNotification)

API calls sent after a successful submission

async_callback_actions (String)

Liquid run in a background job after the submission is saved

async_callback_delay (String)

Liquid that evaluates to the number of minutes to delay the async_callback_actions job

async_callback_max_attempts (Int)

Number of retries of a failed async_callback_actions job

async_callback_priority (AsyncCallbackPriority)

Priority of the async_callback_actions job

authorization_policies (AuthorizationPolicy)

Authorization policies checked on submission

callback_actions (String)

Liquid run after the submission is saved

configuration (HashObject)

Attributes the form accepts and their validations

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

default_payload (String)

Liquid that evaluates to JSON merged into the submitted data before validation

email_notifications (EmailNotification)

Emails sent after a successful submission

flash_alert (String)

Liquid message shown when the submission fails validation

flash_notice (String)

Liquid message shown after a successful submission

id (ID)

Unique identifier of the object

liquid_body (String)

Liquid that renders the form HTML

manually_managed (Boolean)

When true, the resource is managed outside of files: pos-cli deploy and sync never overwrite or delete it

metadata (HashObject)

Free-form data attached to the resource with the metadata key of its file (or the metadata argument of an admin mutation)

name (String)

Name of the form

physical_file_path (String)

Path of the file the resource comes from, relative to the app directory, for
example views/pages/index.liquid or
modules/my_module/public/views/partials/header.liquid. Identifies the resource
in deploy, sync and admin mutations

redirect_to (String)

Liquid path or URL to redirect to after a successful submission

resource (String)

Resource the form saves, for example User or the name of a table

resource_owner (String)

Who can submit the form: creator, self or anyone

sms_notifications (SmsNotification)

SMS notifications sent after a successful submission

spam_protection (HashObject)

Spam protection strategy (recaptcha_v2, recaptcha_v3 or hcaptcha) and its settings

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

Interfaces

AdminSharedAttributesInterface

Attributes shared by resources that can be deployed from files with pos-cli
(pages, partials, layouts, notifications, authorization policies, schemas, assets etc.)