Inboarddocs
For SaaS ownersRequirement types

Download

Ask the installer to download and install a file, plugin, or package.

A download requirement asks the installer to download a file — a plugin, extension, package, or config file — and install it on their platform. The widget presents a clear download link followed by install instructions.

When to use it

Use a download when your product ships as an installable artifact: a WordPress plugin, a Shopify app package, a browser extension, or a config file the installer adds to their project. It's the right type whenever setup starts with "get this file."

How to configure it

You provide:

  • The download URL for the file or package. Use a variable if the link is per-installer (for example a build keyed to their account).
  • The filename / label shown on the download button.
  • The install instructions that follow — Inboard tailors these per platform (e.g. Plugins → Add New → Upload on WordPress).
Download acme-connect-{{accountId}}.zip, then upload it under
Plugins → Add New → Upload Plugin and click Activate.

How it's verified

Downloads are usually verified by self-report — the installer confirms they installed and activated the file. If installing the file makes something detectable (a new endpoint, a snippet on the page), an HTTP check can confirm it instead. A custom check works when your server can see the artifact register itself.

On this page