Restful API

The Restful API action sends a request to an external REST API endpoint, processes the response, and can update form fields or display messages. This is useful for integrating with external systems, fetching or posting data, or triggering remote operations from your workflow.

Properties and Explanation

URL: Enter the endpoint URL of the REST API you want to call.

Header: Define the request headers. You can use the Formula Editor for dynamic header values.

Request: Specify the request payload to send to the API. Supports formulas for dynamic content.

Response: Specify how to handle the API response. You can use the Formula Editor to process or extract values.

Response Message: Set a message to display based on the API response. Supports formulas for dynamic content.

Stop Process From Changing State: If checked, the process will not advance to the next state if the API call fails or returns an error.

• The action sends the request, processes the response, and can update form fields or display messages based on the result.

• Use this action for custom integrations, real-time data exchange, or workflow automation with external RESTful services.

Full Configuration Example

Below is a screenshot of the Restful API action configuration, showing all properties set for URL, header, request, response, response message, and process control:

• In this example, the action is configured to send a request to a REST API, process the response, and display a message or update fields as needed.

• When the action is triggered, the API call is made and the form is updated according to your configuration.