error Action
Last updated
Was this helpful?
Last updated
Was this helpful?
The error action provides a simple and consistent way to handle errors throughout the configuration.
It terminates the flow, sets its body template result as and calls the , if configured, or sends the with the body template result as the value of the error property.
In its simplest form, an error is triggered like this:
To make errors more useful, they should contain a message:
The action body contains a constant JSON string or a representing a JSON object. The object will be assigned to the $error variable.
The following properties of the $error object are optional, but must have the specified type if set. If not set, they will receive the following default values:
message: string, default: 'FlowError'
status: integer between 100 and 599, default: 500
code: integer between 0 and 9999, default: 5000
info: array of string, default: ["Flow Error triggered"]
Additional properties are allowed. They will be accessible in the Error Flow. The following example includes the URL in $error/url:
The status property will be used as the HTTP response status code. The status code may alternatively be defined with the optional status attribute.
If the action body is a string constant (it must be enclosed in double quotes), its value will be assigned to the $error/message property. This is a handy shortcut to trigger simple errors with fixed messages:
The error emits an event with the error topic and the given message:
(Cookbook)