HTTP requests

Use the HTTP request step to make an HTTP request and assign its response to a target variable.

Adding Headers

You can add any number of headers values to your HTTP request by using the add header button.

Only Latin characters, the digits 0-9 and "-" can be used for a header name. Header value can either be written as text or using variables that exists in the app.

You can test out different configuration of HTTP headers by disabling and/or enabling only some of the HTTP headers for the step.

It's important to recognize that further headers may also be added when using a non-client execution context.

Adding Request Body

You are able to edit the Request Body to use either a text variable, binary variable or a JSON expression.

If the HTTP call is a GET, HEAD or DELETE then the Request Body will not be sent with the HTTP request.

Handling Response

You can set the if you want the contents of the response to be typed as either text, binary or as JSON.

If you are expecting the content of the response to be JSON you can write a type expression matching the expected type, or infer it from a JSON value.

Inferring the result type from JSON objects might create a expected response FlowScript type that contain either null or nothing in some fields. This might cause issues when running the application containing the HTTP request step. To avoid such issues, either remove these fields or replace them with the correct nullable or sequence type.

You are also able to choose whether an error status should cause a the application to stop (displaying an error message to the user) or if you want to handle the error manually.

If the HTTP request is configued with the HEAD or DELETE verbs then the response will not contain a response content, and any response configuration will be ignored.

Advanced

Should you want to edit the HTTP request further you can use the Copy as Flowscript button to get a equivalent FlowScript code which can be edited further in a script step.