Skip to main content
Version: Streamsheets 2.4

HTTP.REQUEST

Create an https request. The result, of the request, if any, will be added to the inbox of the given target sheet. You can use the Function Wizard for this function.

Syntax

=HTTP.REQUEST(Producer, Path, Method, Target, [ResultKeys], [Body], [Headers], [Timeout])

Arguments

NameDescription
ProducerProducer to use for submitting the HTTP.request.
PathPath extending the base URL of the connector.
MethodHTTP method of the request.
TargetINBOX(), OUTBOX("MsgID") or a cell range where the result will be placed. Make sure the cell range is big enough or not everything is displayed.
ResultKeysOptional. Limit the result to the specified JSON Keys
BodyOptional. Data to use as the body of the HTTP request.
HeadersOptional. Headers of the HTTP request.
TimeoutOptional. Number of ms after the request times out and an error is returned.

Return Value

The function HTTP.REQUEST() always returns a unique random request ID, which is automatically generated when the service is called. Otherwise an error is displayed.

Example

FunctionResultComment
=HTTP.REQUEST(|Rest, “/path”, “GET”, INBOX())generated Request idThis makes a GET request to “${ConnectorBaseURL}/path” and writes the response to the Inbox.
=HTTP.REQUEST(|Rest, “/path”, “POST”, INBOX(“S2”),, “hello”,A2:B3)
generated Request idThis makes a POST request to “${ConnectorBaseURL}/path” with “hello” as body and “Content-Type: text/plain” and “Custom-Header: example” as headers. The response is placed in the Inbox of S2