Getting Started with Factorial Code Forms

Enable Factorial Code Form

The first step is to create your Factorial Code process and configure the input parameters that will define form fields.

Tip

The input parameters configuration for the form on the Overview page would be:

{
  "title": "Sign-Up Form",
  "type": "object",
  "properties": {
    "name": {
      "title": "Your Name",
      "type": "string"
    },
    "email": {
      "title": "Your Email",
      "type": "string",
      "format": "email"
    },
    "password": {
      "title": "Your Password",
      "type": "string",
      "isSensitive": true,
      "ui": {
        "ui:placeholder": "Use a Secure Password"
      }
    },
    "yourIdDocument": {
      "title": "Upload Your ID Document",
      "type": "string",
      "ui": {
        "ui:widget": "file"
      }
    },
    "plan": {
      "title": "Which Plan Do You Want to Use",
      "type": "string",
      "ui": {
        "ui:widget": "radio"
      },
      "enum": ["FREE", "STARTER", "GROWTH"],
      "default": "STARTER"
    }
  },
  "required": ["name", "email", "password"],
  "embedFormOptions": {
    "loadingOverlayContent": "Creating a New User..."
  }
}

With these input parameters configured, it is time to enable the forms feature. Simply visit the process Dashboard and enable the Forms flag.

Restrict who can open the form

The Authentication field next to the Forms flag decides who may read the form schema and submit it:

• Factorial users of the company that installed the app: every request must carry a Factorial-issued user token in the Fcode-Factorial-Token header, and the company that token belongs to must own the workspace. Requests without an accepted token get a 401. Forms embedded inside Factorial send this token for you.
• Public access: anyone who knows the form URL can open and submit it.

New forms are created requiring a Factorial user. Forms enabled before this field existed keep behaving as public forms until you change them.

Tip

A protected form can still be opened from the playground link on the process dashboard: the playground sends your own Factorial Code token instead, and access is granted through your membership of the workspace.

The same setting lives in the process metadata.json as form.authMode, so it travels with your code through fcode pull and fcode push:

{
  "form": { "enabled": true, "authMode": "FACTORIAL" }
}

Public forms carry no authMode entry. To lift protection from a form that currently requires a Factorial user, set "authMode": "NONE" explicitly — omitting the field leaves the form protected.