Versions Compared

Version Old Version 1 New Version 2
Changes made by

Casey Han

Casey Han

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Image Modified

The HTTP Client Function enables communication with a third-party HTTP server. Using it stream editors can control outgoing requests handling. This function supports REST API and also supports authentication via the OAuth 2.0 framework. The following HTTP Client Functions are available in Usage Engine:

  • Collector

  • Processor

  • Forwarder

The HTTP Client collector Function collector function collects data from a third-party HTTP server. The options are available under the Parameters and Configuration tabs. The Parameters tab allows you You can configure this function to set the values for how the HTTP Client function would behave when communication with the third-party HTTP server. The Configuration tab allows you , and how to specify the method of communication.

The options specific to each of the 3 Functions, whether it is for Collector, Processor or Forwarder, will be mentioned in their corresponding sections at the end of this page.

Parameters

Under Parameters, you get the Connection and Operational Settings that are applicable to HTTP Client Collectors, Processors, and Forwarders. To configure this Function, take the following steps in addition to the ones mentioned in the Connection and Operational Settings.

Image Removed

You can configure this function in the following settings.

  • Connection

  • Operational settings

  • General settings

  • Results

Connection

Depending on the users' configuration, two authentication methods are available: Basic authentication and OAuth 2.0 implementation. A selectable option from the Authentication type is used to make the selection and based on that separate configuration options are available. There will be additional options in the Configuration tab for the Authentication type selected.

Option

Description

Include basic access authentication credentials

Select to add the specified username and password.

Incude query string in URL

Select to include a query string in the URL. Add a key and its corresponding value. You can include multiple query strings.

Customize header

Select to customize the headers of the URL and specify multiple keys and their respective values.

The default value for the HTTP headers “content-type” and “accept” is application/json.

You can override the default value for the HTTP header “content-type.”

It is recommended that the default value for the HTTP header “accept” is left unchanged. The HTTP functions only support application/json.

Rw ui tabs macro
Rw tab
titleBasic authentication

  1. Add the Username and Password if there are any. These options can be left empty.

  2. Add the Target URL of the HTTP request to be made to the HTTP server.

    Note
    titleURL Entry

    Cloud Edition interprets only a single forward slash in the URL fields. Make sure that you format the URLs accordingly. 

  3. In Target URL, enter the URL of the target HTTP server.  You can use Variable Insertion.  You can select a combination of the following options to be included in the URL:

Option

Description

Include basic access authentication credentials

Select to add the specified username and password.

Incude query string in URL

Select to include a query string in the URL. Add a key and its corresponding value. You can include multiple query strings.

Customize header

Select to customize the headers of the URL and specify multiple keys and their respective values.

The default value for the HTTP headers “content-type” and “accept” is application/json.

You can override the default value for the HTTP header “content-type.”

It is recommended that the default value for the HTTP

header “accept” is left unchanged. The HTTP functions only support application/json.

Rw tab
titleOAuth 2.0

The HTTP Method, Target URL, and associated options are configured in the same way. When the Authentication type selection is selected as OAuth 2.0 additional options are displayed. Their configuration is mandatory to properly activate the Function. 

It is also possible to use the Secrets Wallet functionality to apply stored credentials for the three HTTP Functions. 

The Use Redirect Fields checkbox allows users to toggle URL redirection using the available options. Two fields are displayed when this option is enabled – the Target URL field where the designated address is to be entered, and an optional Resource Path. 

The Configure Token section of the Function controls the authentication token credentials. The Header Prefix field is the Authorization header placed before the access token. Based on the Grant Type selection there are two types of credentials access provided for the authentication provisions – Password and Client credentials. Each of them has a distinctive configuration option. 

Password Credentials Grant Type Options

  • Access Token URL – In this field specify the URL containing the authorization token. 

  • Client ID – In this field enter the client identifier. 

  • Client Secret – in this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string. 

  • Username – This field is used to specify the relevant username, it is mandatory. 

  • Password – This field is used to specify the password associated with the username, it is mandatory. 

  • Scope – The authorization and token endpoints allow the client to specify the access request scope using this parameter. The entered value must be expressed as a list of space-delimited, case-sensitive strings. This is an optional parameter.

  • Client Authentication – This option controls the type of authentication mechanism as defined by the connecting server – Auth Header or Auth Body are available. The options are named "Send as Basic Auth Header" and "Send client credentials in body". 

Client Credentials Grant Type Options 

  • Access Token URL – In this field specify the URL containing the authorization token. 

  • Client ID – In this field enter the client identifier. 

  • Client Secret – in this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string. 

  • Scope – The authorization and token endpoints allow the client to specify the access request scope using this parameter. The entered value must be expressed as a list of space-delimited, case-sensitive strings. This is an optional parameter.

  • Client Authentication – This option controls the type of authentication mechanism as defined by the connecting server – Auth Header or Auth Body are available. The options are named "Send as Basic Auth Header" and "Send client credentials in body". 

Both grant-type options also include optional parameters: 

  • Include query string in URL – This enables a query string in the token URL. 

  • Customize header - This allows for custom headers to be specified.

Image Added

Operational Settings

In Operational Settings, enter the following details that determine how you want to handle the errors. The following options are available for HTTP Collector and Processor Functions only:

In Request run limit, specify the number of times the operation should run. 

In Action on error, specify the action you want to take in case of an error. You can select from the following options:

Action on error options

Description

Ignore

Select to ignore the error and the stream keeps on running.

Stop the stream

Select to stop the stream.

Any response with the HTTP status code 4xx or 5xx is considered an error. All errors get logged in the system logs. You can refer to the Logs for more information. The default value is Ignore.

Configuration

In the Configuration tab,  select

General settings

You select an HTTP request method from the following options:

HTTP Method

Description

GET

Request data from the target server.

POST

Sends data to the target server. Select either Body or Form under Content*.

PUT

Replaces the current resources of the target URL with the uploaded content. Select either Body or Form under Content*.

PATCH

Updates partial resources of the target URL. Select either Body or Form under Content*.

DELETE

Removes all current representations of the target resource.

Note
title

Note!

*The Body and Form fields are visible only for request methods POST, PUT and PATCH.

  1. Select Body or Form and add the corresponding details in the content of the request message. You can use Variable Insertion.

  2. Expand the examples below to view samples of HTTP request messages for Body or Form:

Note
title

Note!

The form input needs to be URL encoded, otherwise, it fails.

HTTP requests use a hardcoded content-type value of ‘application/x-www-form-urlencoded’. 

Expand
titleSample of an HTTP body content message


No Formatcode
{
"name" : "my_username",
"first-name" : "My",
"last-name" : "Username",
"display-name" : "My Username",
"email" : "user@example.test",
"active" : true
}


Expand
titleSample of an HTTP form content message


No Formatcode
name=my_username&first-name=My&last-name=Username&display-name=My%20Username&email=user@example.test&active=true


Results

Response Headers

The support for response headers can be enabled by toggling the Enable response headers option.A default value for the key will be added by the engine (httpResponseHeaders) which will match the placeholder for the key input. Configuration is done by filling up the necessary input fields: Result Header Key and Result Key.

Note

HTTP Response Headers Support

By enabling response headers, the overall data size of the HTTP packets will also increase. Caching of the body checkbox is tied to the headers. 

This option is available only for the HTTP Client collector and the HTTP Client Processor.

In Result Key, you can assign a name to the result that you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable. The default value is httpResponse.

Info

Token Renewal Support

The collector and processor Functions support token renewal, if the servers return a 401 Token Expiry error.