ByteChef LogoByteChef

Form

Component for handling form submissions and requests.

Categories: Helpers

Type: form/v1


Triggers

New Form Request

Name: newFormRequest

Triggers when a new form request is received.

Type: STATIC_WEBHOOK

Properties

NameLabelTypeDescriptionRequired
formTitleForm TitleSTRINGThe title for your form. Displayed as the main page title (h1).false
formDescriptionForm DescriptionSTRINGA subtitle shown under the form title. Use
or <br> for line breaks.false
buttonLabelButton LabelSTRINGLabel for the submit button.false
ignoreBotsIgnore BotsBOOLEAN
Options true, false
Ignore requests from bots and link previewers.false
useWorkflowTimezoneUse Workflow TimezoneBOOLEAN
Options true, false
Use the workflow timezone for the submittedAt timestamp instead of UTC.false
appendAttributionAppend AttributionBOOLEAN
Options true, false
Show an attribution footer on the public form.false
customFormStylingCustom Form Styling (CSS)STRINGOverride default form styles with custom CSS.false
inputsForm InputsARRAY
Items [{INTEGER(fieldType), STRING(fieldLabel), STRING(fieldName), STRING(fieldDescription), STRING(placeholder), STRING(defaultValue), STRING(defaultValue), [{STRING(label), STRING(value)}](fieldOptions), BOOLEAN(multipleChoice), INTEGER(minSelection), INTEGER(maxSelection), BOOLEAN(required)}]
Define the form input fieldstrue

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Form Request",
  "name" : "newFormRequest",
  "parameters" : {
    "formTitle" : "",
    "formDescription" : "",
    "buttonLabel" : "",
    "ignoreBots" : false,
    "useWorkflowTimezone" : false,
    "appendAttribution" : false,
    "customFormStyling" : "",
    "inputs" : [ {
      "fieldType" : 1,
      "fieldLabel" : "",
      "fieldName" : "",
      "fieldDescription" : "",
      "placeholder" : "",
      "defaultValue" : "",
      "fieldOptions" : [ {
        "label" : "",
        "value" : ""
      } ],
      "multipleChoice" : false,
      "minSelection" : 1,
      "maxSelection" : 1,
      "required" : false
    } ]
  },
  "type" : "form/v1/newFormRequest"
}

How is this guide?

Last updated on

On this page