Skip to main content

HTTP Request Action

Yeeflow's HTTP Request Action integrates with external systems, allowing customizable web requests and handling responses for workflow use.

Use HTTP Request in a workflow to call a server and use its response in later steps. For example, retrieve a demo order’s status from a test ERP endpoint. In the workflow designer, add Http request from Integration, select it on the canvas, and open its settings.

Configure the request

  1. Http address. Enter the API endpoint. Use the Expression Editor to enter a fixed address or combine it with a workflow variable. Replace the example https://api.example.com/v1/orders/DEMO-001 with your test endpoint.

  2. Method. Choose GET, POST, PUT, or DELETE as specified by the API. The demo order lookup uses GET.

  3. Authentication type. Use No authentication when the request uses an access rule such as an allowlist or provides credentials through a header. Choose User/Password for an API that expects this mode. Use the built-in HTTP service for supported Yeeflow API calls.

  4. Http header. Map a Dictionary variable containing the header names and values. For example, add Accept: application/json and, if required, Authorization: Bearer TEST_TOKEN. Use Set Variable to populate the dictionary. Replace TEST_TOKEN with the test credential supplied for your API. Keep actual values out of examples. Set Variable Action

  5. Data. If the API expects a request body, use the Expression Editor to build it in the required format and set any required content type. For a read-only endpoint such as the demo lookup, check whether the API expects the body to be empty.

English Http request settings panel showing request fields, the numeric response status field labeled Source code, and Result for a dictionary or list variable.

Store the response

  • Status Code. Select a Number workflow variable, for example httpStatus. The illustrated designer labels the numeric response field Source code.

  • Result. Select a Dictionary or List workflow variable to match the API response. If the endpoint returns an object such as {"orderId":"DEMO-001","state":"ready"}, use a Dictionary. In a test run, check that the response contains the expected keys and that later steps read the intended value.

Verify success and failure

In a test workflow, compare the captured status and result with the API’s documented success response. Use that status and the required result fields in the success path. For example, route the order lookup forward when the API returns 200 and the response includes the expected order ID and state.

Run separate tests for a success response, a documented non-2xx response such as 404, and an endpoint that cannot be reached. When the workflow captures an error response and reaches the outgoing conditions, route that case to the configured failure path. If no status is captured or the workflow stops at the action, check the workflow instance and endpoint logs before continuing. For requests that create or change records, verify the target state before retrying. View and manage workflow instances

For HTTP calls initiated from a form action, see HTTP request step.

Did this answer your question?