Throw error

The Throw error action allows you to manually trigger an error in your API workflow. This is useful for handling logical errors (like invalid user input or failed validation) or for stopping a workflow when something goes wrong.

How it works

When this action is executed:

1. The current workflow branch stops immediately.
2. If the action is inside a Try/Catch block, the Catch branch is triggered.
3. If not, the error bubbles up to the nearest parent Try/Catch. If there is no parent Try/Catch, the workflow stops and the error appears in the logs and debugger.

Configuration

You can customize the error details in the side panel:

Option	Description
Message	A readable description of the error (e.g. "Invalid email format"). This becomes the message property on the caughtError object (available as caughtError.message).
Cause	Optional additional details (e.g. "validation_failed"). This becomes the cause property on the caughtError object (available as caughtError.cause).

Example use case with Try/Catch

Commonly used for validating data before proceeding with an action.

1

Validate input

Use a True/False split action to check if a required field is missing or invalid.

2

Throw error

Inside the True branch, add a Throw Error action with a clear Message like 'Field is required'.

3

Handle in Catch

Wrap this in a Try/Catch block. In the Catch branch, use a Send response action and bind its message to caughtError.message so the API caller receives the error details.

CONTINUE LEARNING

Now that you know how to raise custom errors, learn how to catch and handle them with Try/Catch:

Handling errors with Try/Catch →