Skip to main content
A Workflow is the rule the merchant configures in the Filecheck admin. It controls:
  • Which files are accepted (types, counts, sizes).
  • What validation and preflight checks run.
  • What remediation is attempted.
  • What happens on failure (the onFail policy).
Each Workflow has an id (wf_…) that you pass to the Element as workflowId.
The option is workflowId, not ruleId. This is the most common integration mistake.

The onFail policy

The Workflow’s onFail policy decides whether a file with problems can still proceed. Filecheck collapses this policy into a single canProceed flag on every status event, so your code never has to interpret the policy itself.
PolicyResult
RejectFiles with errors are blocked (canProceed: false).
Accept with warningsFiles with warnings can proceed (canProceed: true, status partial).

Mapping Workflows to products

Set a default Workflow for your store and override it per product. In the plugins, this is a per-product setting; via the Element, pass a different workflowId per page.

Jobs

See what happens when a file runs through a Workflow.