HomeGuidesAPILog In

Zip Action

The Zip action is a feature that allows you to compress generated documents into a zip file. This reduces the size of files as well as providing the option to securely store multiple documents in a password protected format.


  • A zip file can be protected with a password by setting the Password Protect input in the Action to true. The password will be taken from the Password input in the Action, and if that is not set, it will use the password specified in the Manage section.
  • Enables the addition of the generated Zip file to pre-existing actions, for instance, including the Zip file as an attachment in a Send Email action.
  • Select which files will be included in the zip file.



Default Password

Establish a default password to be automatically applied in case the Password Protect input in the Action has been enabled and no password has been manually entered. The operation will fail if password protection is selected but no password is provided in either Design or in Manage.

The zip file will appear for download on the submission confirmation page.

Output FilenameAssigns a designated name for the generated Zip file. If no value is specified, the Zip file will use the Project name.
PasswordThe password for the Zip file.
Password ProtectEnables password protection for the Zip file if this value is set to true and will use the password provided in the Password input of the action. If no password is provided, the global default password defined in Manage will be applied.
AES EncryptionSetting this to True will encrypt the Zip with AES-256 encryption. Note that a third party unzip solution may be required for end users opening files created with this option enabled.


Opening the Zip File

  • When you open a zip file using a file explorer such as Windows Explorer, attempting to access a protected file within the archive will prompt for a password. This password will also automatically unlock the rest of the files in the zip archive.
  • If AES encryption is set to true, end users will need a zip utility compatible with AES Encryption. E.g The Windows native uncompress zip functionality is not compatible. Archive utility on Mac OS is. Ref: https://devblogs.microsoft.com/oldnewthing/20180515-00/?p=98755
  • If you download a zip file, extract its contents, and are prompted for a password, entering the correct password will allow you to access all the extracted files without the need for additional passwords.