HTTP Request

Most recent version: v0.0.2

See the changelog of this Action type here.

Overview

The HTTP Request action allows you to configure and execute HTTP requests with custom settings for methods, headers, authentication, TLS, and more.

In order to configure this action, you must first link it to a Listener. Go to Building a Pipeline to learn how to link.

Ports

These are the input and output ports of this Action:

Input ports

• Default port - All the events to be processed by this Action enter through this port.

Output ports

• Default port - Events are sent through this port if no error occurs while processing them.

• Error port - Events are sent through this port if an error occurs while processing them.

Configuration

1

Find HTTP Request in the Actions tab (under the Advanced group) and drag it onto the canvas. Link it to the required Listener and Data sink.

2

To open the configuration, click the Action in the canvas and select Configuration.

3

Enter the required parameters:

Parameter	Description
HTTP Method*	The HTTP method for the request. Choose between GET, POST, PUT, DELETE, or PATCH.
Server URL*	The target URL for the HTTP request.
Field that holds the request body	Enter the name of the field that includes the request body.
Field where the response will be stored	Enter the name of the field that will store the HTTP response.
HTTP Headers	Optionally, you can enter a map of header key-value pairs to include in the request.
Timeout (seconds)	Enter the timeout for the HTTP request in seconds.
Disable Redirects	Select true to disable HTTP redirects or false to ignore.
Content-Type	Set the request content-type: text/plain - Plain text with no formatting. application/json - Data in JSON format. This is the default value. application-xml - Data in XML format. text/html - Data in HTML format.

Authentication Configuration

Choose the type of authentication for the request.

Parameter	Description
Authentication Type*	Choose between None, Basic, Bearer, or API Key.

Authentication Credentials

Depending on the option you chose above, you must enter the required authentication information in this section:

Parameter	Description
Basic Authentication	Username and Password for basic authentication. For the password, choose one of the secrets defined in your Tenant or create a new one by clicking New secret. Learn more about secrets in this section.
Bearer Token	Token for Bearer authentication. Choose one of the secrets defined in your Tenant or create a new one by clicking New secret. Learn more about secrets in this section.
API Key	Define the API Key Name and API Key for API Key configuration. For the API key, choose one of the secrets defined in your Tenant or create a new one by clicking New secret. Learn more about secrets in this section.

Bulk Configuration

Set bulk allow to true and configure these options if you want to set bulk sending in your HTTP requests:

Parameter	Description
Store as	Decide how to store events in your responses. Choose between: Delimited - Events in a batch are stored separated by a delimiter. Set the required delimiter in the option below. The default option is newline (\n). Without Delimeter - Events are concatenated without any separator. JSON Array - Events are structured in a JSON array.
Events per batch*	Set the number of individual events per bulk request.
Maximum number of buffers per server URL	Set the maximum number of buffers per server URL. The default value is 25, and the maximum value is 50.
Event time limit	Time in seconds to send the events.

Rate Limiter Configuration

Establish a limit for the number of HTTP requests permitted per second.

Parameter	Description
Number of requests per second	Enter the maximum number of requests that can be sent per second. The minimum is 1.

TLS Configuration

Optionally, you can specify the TLS configuration of the Data sink. If empty, then TLS will be disabled for the Data sink.

Parameter	Description
Certificate	Choose the predefined TLS certificate.
Private Key	The private key of the corresponding certificate.
CA Chain	The path containing the CA certificates.
Minimum TLS version	Minimum TLS version required for incoming connections. The default version is v1.2

Proxy Configuration

If your organization uses proxy servers, set it using these options:

Parameter	Description
URL	Enter the required proxy URL.
Username	Enter the username used in the proxy.
Password	Enter the password used in the proxy.

Retry Configuration

Set how you want to manage retry attempts in case of errors in the requests:

Parameter	Description
Max Attempts	Set the maximum number of attempts before returning an error. The minimum value is 1.
Wait between attempts	Choose the milliseconds to wait between attempts in case of an error. The minimum value is 100.
Backoff interval	Define how the wait time should increase between attempts, in seconds. The minimum value is 1.

4

Click Save to complete.

Example

{
    "payloadField": "correlationIDKey",
    "outField": "outputField",
    "serverUrl": "http://localhost:8080/${path_from_event}?${impactKey}=${correlationIDKey}",
    "method": "POST",
    "authentication": {
        "authType": "apiKey",
        "credentials": {
            "apiKey": {
                "apiKeyName": "x-api-key",
                "apiKeyValue": {
                    "id": "apiKey",
                    "value": "ad1dewfwef2321323"
                }
            }
        }
    }
}

Click Save to complete.