Skip to content

Form

A reusable form template configured at the organisation level. Defines the fields to capture, their types, validation, display settings, triggers, rules, and actions.

FieldTypeDescription
id*UUID!
key*EntityKey!Stable identifier, unique within organisation. Alphanumeric and underscores only.
name*String!
descriptionString
fields*[FormField!]!
triggersObjectTrigger conditions that determine when the form is surfaced on bookings. Stored as structured JSON. See condition schema documentation.
rulesObjectRules that dynamically override field modes based on booking context and field values. Stored as structured JSON. See condition schema documentation.
actionsObjectPost-submission actions that execute side-effects on linked entities. Stored as structured JSON. See condition schema documentation.
allowMultipleResponses*Boolean!If true, users can submit again after an initial submission. If false, the form is locked after first submission.
createdAt*Timestamp!
modifiedAt*Timestamp!
deleted*Boolean!Whether this form template has been soft-deleted.
organisation*OrganisationReference!The organisation that owns this form.