Form schema

Form schema covers The object form builder for sections, questions, field types, validation, metadata, aliases, bulk insert, and AI sample data. Use this page when you are configuring the live product surface, planning a rollout, or checking why users see different data from what an administrator sees.

What this surface is

Primary purpose: The object form builder for sections, questions, field types, validation, metadata, aliases, bulk insert, and AI sample data.
Where staff start: Open Global settings > Objects, then choose an object from /settings/objects.
Where admins configure it: Edit fields at /settings/objects/:objectId/questions; task and ticket categories have similar schema builders for their forms.
Runtime/detail surface: Schema output appears in record create/edit forms, public forms, portal forms, imports, reports, scripts, and JQL responses.
Platform connections: Schema changes affect validation, automation payloads, dynamic pages, imports, and any code that reads object fields.

Common workflows

Workflow	What happens	Where to check
Start with	Start with the business process and write down the minimum data required to create the record	Confirm in the product route above before publishing.
Create sections	Create sections that match how users think: identity, contact details, status, financials, attachments, or review notes	Confirm in the product route above before publishing.
Add questions	Add questions with clear labels, helper text, required flags, defaults, and field types that match reporting needs	Confirm in the product route above before publishing.
Use lookup,	Use lookup, select, date, money, file, and long-text fields deliberately; field type affects filters and exports	Confirm in the product route above before publishing.

Configure it

Start with the business process and write down the minimum data required to create the record.
Create sections that match how users think: identity, contact details, status, financials, attachments, or review notes.
Add questions with clear labels, helper text, required flags, defaults, and field types that match reporting needs.
Use lookup, select, date, money, file, and long-text fields deliberately; field type affects filters and exports.
Check alias and reference-number settings before integrations or public forms start sending data.
Preview create and edit flows as a staff user and as a portal or public user when those surfaces are enabled.
Run a small bulk insert or sample record test to verify required fields, defaults, and file handling.
Document ownership of each section so later admins know which team can request schema changes.

Configuration options

Option	Use when	Notes
Section	Group related questions	Use for cleaner forms and conditional layouts.
Required question	Data must be present before save	Avoid making downstream-only fields required at creation.
Lookup field	A record must connect to another object or static model	Confirm the target object and display label.
File upload	Evidence, documents, photos, or signed forms are needed	Pair with file-size and retention policies.
Alias/reference	External systems or humans need a stable identifier	Set before publishing public links.
AI sample data	Builders need realistic testing data	Review generated values before using them in demos.

Operating notes

Changing a field label is safer than changing a field alias after scripts, reports, or API clients depend on it.
Deleting fields can break reports, page blocks, workflow decisions, and integrations that expect that key.
Use sections to reduce form fatigue; do not build one giant section with every question.
When public users submit the form, keep internal-only fields hidden from the public layout.
For imports, make field names and option values match the spreadsheet template to reduce failed rows.
Record detail pages may show schema fields in different panes, so test both form and view states.
If a value does not filter correctly, check whether the field type supports that filter operator.
Use sensible defaults for status, source, owner, and priority fields that drive automation.
Treat schema changes as migrations when the object is already used in production.
Keep a changelog for high-value objects such as customers, assets, applications, or invoices.

For developers

Use the developer and reference pages when this configuration is read or changed by code, scripts, widgets, embeds, API clients, or webhooks.

Form schema

Form schema

What this surface is

Common workflows

Configure it

Configuration options

Operating notes

For developers

Related links