Skip to main content

HTTP Invoker

The HTTP Invoker task is used to send HTTP Requests to external services (e.g. REST-based APIs).

Configuration

HTTP Invoker Task Options
HTTP Invoker Task Configuration
ConfigurationDescription
MethodHTTP Request Method: GET, POST, PUT, PATCH, DELETE
URLHTTP URL
TimeoutHTTP Timeout in seconds (1 - 110s)
Wait For CallbackIf switched on the Flow will pause and wait for external service to respond via Callback URL (supports FenX Token or Custom Authentication).
Callback TimeoutTimeout for callback waiting when Wait For Callback is enabled (1 second up to 7 days).
Content TypeHTTP Request Content Type: None, Json, Xml, Plain Text, Form Data, Form Url Encoded, Binary File
Note: Affects HTTP Request Body
BodyHTTP Body. Templated Input (Single Variable or Custom Definition)
ParamsDictionary. Query String Parameters in Key/Value pairs. E.g. https://www.domain.com/?Key1=value&Key2=value
Key is a text field and must be unique
Value is text field that accepts variable substitution
HeadersDictionary. Request Headers in Key/Value pairs.
Key is a text field and must be unique
Value is text field that accepts variable substitution
Large ResponseStores large responses in Persisted Storage instead of returning the full payload inline. Not supported together with Wait For Callback.
Storage KeyFile identifier used when Large Response is enabled.
Storage TTLRetention policy used for the stored response file when Large Response is enabled.
Storage SensitivitySensitivity classification for the stored response file when Large Response is enabled.
Send Storage FileSends a previously stored file as request payload (instead of Body).
Request Storage KeyFile identifier to read from Persisted Storage when Send Storage File is enabled.

Authentication

HTTPInvoker uses External Authentication to support MTLS and OAuth Authentication schemes. Register the base URL or individual URLs in External Authentication and HTTPInvoker will use that to seemlessly manage the authentication for each outbound request, including caching and renewing authentication tokens.

Task Output

HTTP Invoker produces the following Task Output that can be used as Variable Input in your subsequent tasks.

HTTPInvoker Output (via Step Log Details)
Task Output (via Step Log Details)
Output VariablesDataTypeDescription
StatusCodeNumberHTTP response status code.
ResponseBodyJsonHTTP Response Body parsed as a Json-object
RawResponseTextRaw Response body from server stored as String. Useful when using XML or other non-Json Content Types
ResponseHeadersJsonHTTP Response Headers received from server
CallbackRequestJsonCallback Request Details (path, headers, body)
ContentTypeTextResponse content type from the HTTP response.