Fail States

The Fail state ("Type": "Fail") terminates runs and marks them as failures.

Fail states may contain an Error and a Cause, both of which can be set via JSONPath expressions. These fields are purely informative, for users reading the failure.

Fields

The following fields are the valid parameters to a Fail state.

Error: An "error" string to record for the failure. Typically an error code or other short identifier.
Cause: A "cause" string to record for the failure. Typically an error description or other more verbose explanation.
CausePath: A JSONPath expression indicating a source in the flow run's current data for the Cause field. Mutually exclusive with Cause.
ErrorPath: A JSONPath expression indicating a source in the flow run's current data for the Error field. Mutually exclusive with Error.

Examples

{
  "Type": "Fail",
  "Error": "NotCoolEnough",
  "Cause": "Its over 40 degrees C. The flowers are wilting."
}

{
  "Type": "Fail",
  "ErrorPath": "$.error.code",
  "CausePath": "$.error.message"
}