Forms

Read and edit forms and manage their submissions from a workflow.

`core.forms.list_forms`

List the workspace’s forms, newest first. Enterprise Edition

Inputs

string | null

next_cursor from a previous page.Default: null.

integer

Maximum number of forms to return.Default: 20.

Examples

List forms

- ref: list_forms
  action: core.forms.list_forms
  args:
    limit: 50

`core.forms.get_form`

Get a form: its status, its config, the issues the config has against the workflow’s inputs, and its URL. Enterprise Edition

Inputs

string

required

The form ID, as returned by list_forms.

Examples

Get a form

- ref: get_form
  action: core.forms.get_form
  args:
    form_id: 0b9f6c1e-5a47-4d1b-9c3e-2f7a8d6e4b10

`core.forms.update_form`

Update the form of a workflow, creating it if the workflow has none. A form turns the workflow’s input schema into a page people fill in; submitting it runs the workflow. Returns the form, including any issues with the config. Enterprise Edition

Inputs

string

required

The workflow the form belongs to (short wf_... or full ID).

object | null

The whole form config; it replaces the stored one. Keys, all optional: title, description (markdown), success_message, and layout, an ordered list of entries. An entry is one of {field: <input name>}, {heading: <text>}, {text: <markdown>}, {notice: <text>, tone: info|success|warning|danger} or {divider: true}. A field entry may add label, help, placeholder, widget (text, long_text, number, toggle, select, multi_select, cards, tags, date, datetime, user, file), options ([{value, label, description}]), visible_if ({field, equals}), autofill (requester, requester.user_id, requester.email, requester.first_name, requester.last_name, submission.id) or hidden. A file field may add accept (extensions or MIME types, e.g. [".pdf", "image/*"]) and max_files (1 to 10; more than 1 needs a list[dict] input). Workflow inputs left out of layout are appended in schema order. Omit config to leave it unchanged.Default: null.

string | null

online lets people submit the form (the workflow must be published); offline stops submissions. Omit to leave unchanged.Default: null.

Examples

Put a form online with a card picker

- ref: update_form
  action: core.forms.update_form
  args:
    workflow_id: wf_3mYp8JkL2nQr7sTu9vWx0Z
    status: online
    config:
      title: Laptop request
      layout:
        - field: model
          widget: cards

`core.forms.list_submissions`

List a form’s submissions with their answers, newest first. Enterprise Edition

Inputs

string

required

The form ID.

string | null

next_cursor from a previous page.Default: null.

integer

Maximum number of submissions to return.Default: 20.

string | null

Only submissions at or after this time.Default: null.

string | null

Only submissions before this time.Default: null.

Examples

List submissions older than 90 days

- ref: list_expired
  action: core.forms.list_submissions
  args:
    form_id: 0b9f6c1e-5a47-4d1b-9c3e-2f7a8d6e4b10
    submitted_before: ${{ FN.now() - FN.days(90) }}
    limit: 200

`core.forms.get_submission`

Get one form submission with its answers and who submitted it. Enterprise Edition

Inputs

string

required

The submission ID. A form-triggered workflow gets its own from an input with autofill: submission.id.

Examples

Get the submission that started this run

- ref: get_submission
  action: core.forms.get_submission
  args:
    submission_id: ${{ TRIGGER.submission_id }}

`core.forms.delete_submission`

Delete a form submission and its stored answers. The workflow run it started keeps its own copy of the inputs. Files uploaded with the submission are deleted too. Enterprise Edition

Inputs

string

required

The submission ID.

Examples

Delete each listed submission

- ref: delete_expired
  action: core.forms.delete_submission
  depends_on:
    - list_expired
  for_each: ${{ for var.submission in ACTIONS.list_expired.result.items }}
  args:
    submission_id: ${{ var.submission.id }}

`core.forms.download_file`

Download a file uploaded with a form submission. File integrity is verified via SHA256. Enterprise Edition

Inputs

string

required

The file ID: the id of the file object a file field puts in the workflow’s inputs.

Examples

Download a file attached to the submission

- ref: download_quote
  action: core.forms.download_file
  args:
    file_id: ${{ TRIGGER.quote.id }}

Request

Transform

Workflow

Agent

Case

Table

Form

`core.forms.list_forms`

Inputs

Examples

`core.forms.get_form`

Inputs

Examples

`core.forms.update_form`

Inputs

Examples

`core.forms.list_submissions`

Inputs

Examples

`core.forms.get_submission`

Inputs

Examples

`core.forms.delete_submission`

Inputs

Examples

`core.forms.download_file`

Inputs

Examples

​core.forms.list_forms

​Inputs

​Examples

​core.forms.get_form

​Inputs

​Examples

​core.forms.update_form

​Inputs

​Examples

​core.forms.list_submissions

​Inputs

​Examples

​core.forms.get_submission

​Inputs

​Examples

​core.forms.delete_submission

​Inputs

​Examples

​core.forms.download_file

​Inputs

​Examples

`core.forms.list_forms`

Inputs

Examples

`core.forms.get_form`

Inputs

Examples

`core.forms.update_form`

Inputs

Examples

`core.forms.list_submissions`

Inputs

Examples

`core.forms.get_submission`

Inputs

Examples

`core.forms.delete_submission`

Inputs

Examples

`core.forms.download_file`

Inputs

Examples