HTTP call

Description

This unit is a Sink unit type.

A unit that sends http requests to a configurable endpoint. The response is stored in a configured field of the output event.

Events enter through the in port and are transformed according to the unit configuration. The events are enriched with the response field and unit configurations and sent to the out port.

If an error occurs, the input event is enriched with new fields describing the problem, and the event is sent through the error port.

Configuration

After dragging this unit into the Flow canvas, double-click it to access its configuration options. The following table describes the configuration options of this unit:

Tab	Field	Description
General	Name	Enter a name for the unit. It must start with a letter, and cannot contain spaces. Only letters, numbers, and underscores are allowed.
	Schema	The protocol of the request.
	Host	Use the template to enter the target server address (can contain references to the input event fields). Template format: text %%{variable} text
	Path	Use the template to enter the path of the HTTP endpoint (can contain references to the input event fields). It should start with a slash. Template format: text %%{variable} text
	Accept self-signed certificate	If true, Self Signed Certificates are allowed and hostname verification is disabled.
	Method	Select the required HTTP method.
	Timeout	Connection request timeout (in seconds).
	Response field	Enter a name for the output event field containing the response body.
	Response headers field	Enter a name for the output event field containing a map with all response headers.
	Parameters	Click the plus icon to add field, name, value combinations for parameters. Here are the possible combinations and their outcomes (click to expand): From field: Name and value taken from event. From field and name: Name taken from settings and value from event. From field and value: Name taken from event and value taken from event (if present) or from settings (default value). From field, name and value: Name taken from config and value taken from event (if present) or from settings (default value). Name and value: Name and value taken from settings (fixed parameter). You can collapse and expand the parameters using the icon, reorder using the arrows, or delete using the X icon.
	Headers	Click the plus icon to add field, name and value combinations for headers. The possible combinations and outcomes are the same as for Parameters. You can collapse and expand the headers using the icon, reorder using the arrows, or delete using the X icon.

Input ports

Port	Description
in	All events enter through this port.

Output ports

Port	Description
out	Outputs events enriched with the response field and unit configurations.
error	Signals when an error occurred. Input events are enriched with standard error fields.

Download as PDF