Call Rest API

The Call REST API action allows you to trigger a pre-configured API call directly from your app. It is typically used to send or retrieve data from a remote server based on user actions or events.

Use Cases

• Submitting a form to a backend service.

• Fetching dynamic data to update UI.

• Sending user input to an external system.

Properties

Property	Description
dataSource	(Required) The API configuration to be triggered. You must have defined the API under your Data Sources.
successCondition	A boolean condition to determine whether the API response should be considered successful.
onSuccess	An optional action flow that runs if the call succeeds or the success condition evaluates to true.
onError	An optional action flow that runs if the call fails or the success condition is false.

Default Behavior

By default:

• The API call is made using the selected dataSource.

• If onSuccess or onError flows are configured, they are triggered conditionally based on the response and the success condition.

• No built-in loading or error feedback is shown; use additional actions like Show Toast for visual feedback.

How to Use

1. Add the action to a widget (e.g., on form submission or button click).

2. Select Call REST API from the action list.

3. Choose a dataSource.

4. Optionally define onSuccess and onError flows based on the API outcome.