In interaction web forms, a fileDownload element displays a form button that downloads an attachment or automation resource file when clicked.

This is particularly useful for interactions that generate large or binary output, like a dynamic image, a CSV/JSON export, or a ZIP archive.

start:
  await:
    form:
      title: Interaction Download
      elements:
        fileDownload/prompt_file:
          label: Download:
          uri: cerb:automation_resource:3b1f58c2-1234-11ed-b9e9-01791ccb5549
          filename: example.zip

Syntax

data:

(Added in 11.0)

The raw content to download. Alternative to uri:.

label:

The optional label to display above the form element.

filename:

The filename to show on the download button.

hidden:

This form element can be conditionally hidden.

hidden@bool: {{not worker_is_superuser}}

uri:

A URI for an attachment, automation resource, or resource to download. Alternative to data:.