WebsiteBlogLogin

HTTP

Most recent version: v1.3.0

See the changelog of this Listener type here.

Overview

Onum supports integration with HTTP. Select HTTP from the list of Listener types and click Configuration to start.

Configuration

Now you need to specify how and where to collect the data and how to establish an HTTP connection.

Metadata

Enter the basic information for the new Listener.

Parameter
Description

Name*

Enter a name for the new Listener.

Description

Optionally, enter a description for the Listener.

Tags

Add tags to easily identify your Listener. Hit the Enter key after you define each tag.

Configuration

Cloud Listeners

Note that you won't see the Socket and TLS configuration sections in the creation form if you're defining this Listener in a Cloud instance, as these are already provided by Onum. Learn more about Cloud Listeners in this article.

Socket

Parameter
Description

Port*

Enter the port number used by the server or client to establish an HTTP connection.

TLS configuration

Note that the parameters in this section are only mandatory if you decide to include TLS authentication in this Listener. Otherwise, leave blank.

Parameter
Description

Certificate*

This is the predefined TLS certificate.

Private key for this listener*

The private key of the corresponding certificate.

CA chain

The path containing the CA certificates.

Client authentication method*

Choose between No, Request, Require, Verify, and Require & Verify.

Minimum TLS version*

Select the required version from the menu.

Authentication

Parameter
Description

Authentication Type*

If your connection does not require authentication, leave as None. Otherwise, choose the authentication type and enter the details.

Authentication credentials

The options provided will vary depending on the type chosen to authenticate your API. This is the type you have selected in the API end, so it can recognize the request.

Choose between the options below, or select None if you don't need any authentication.

Basic

  • Username - the user sending the request.

  • Password - choose the basic auth password from your list of secrets or create a new one.

Bearer

Bearer Token Authentication

Enter your Token Secret for the API request using an existing Secret or creating a new one if you haven't stored it in Onum yet.

This grants access without needing to send credentials (like username and password) in every request.

API Key

Enter the following:

  • API key name - a label assigned to the API key for identification. You can find it depending on where the API key was created.

  • API Key - API keys are usually stored in developer portals, cloud dashboards, or authentication settings. Choose the existing Secret or create a new one if you haven't stored this key within Onum.

Note that the HTTP Listener expects the API Key to be included in the URL, as a query parameter. For example:

curl --location 'http://customer.in.prod.onum.com:2250/test?My-Token=1234567890qwerty' \
--header 'Content-Type: application/json' \
--data '{"message": "hello, how are you doing? :)"}'

Endpoint

Parameter
Description

HTTP Method*

Choose GET, POST, or PUT method.

Request path*

Path to the resource being requested from the server.

Message extraction

Parameter
Description

Strategy*

The strategy defines how data extraction should be performed. It is the overall methodology or approach used to extract relevant information from HTTP messages. Choose between:

  • Single event with the whole request - Choose this option if you want to include the whole request in each event.

  • Single event from request path - Choose this option if you want to include the request paths in each event.

  • Single event as query string - Choose this option if you want to include the requests with their whole query strings.

  • Single event as query parameter - Choose this option if you want to include a specific request parameter in your events. Specify the required parameter name in the Extraction info option (for example: msg)

  • Single event as header - Choose this option if you want to include a specific header in your events. Specify the required header in the Extraction info option (for example: Message)

  • Single event as body (partially) - Choose this option if you want to include a part of the request body in your events. Specify the required RegEx rule to match the required part in the Extraction info option (for example: \\[BODY: (.+)\\])

  • Single event as body (full) - Choose this option if you want to include the whole request body in your events. Specify the required RegEx rule to match the required part in the Extraction info option (for example: \\[BODY: (.+)\\])

  • Multiple events at body with delimiter - Choose this option if you want to include several messages in the same event separated by a delimiter. You must specify the delimiter in the Extraction info option.

  • Multiple events at body as JSON array - Choose this option if you want to include several messages formatted as a JSON array in your events.

  • Multiple events at body as stacked JSON - Choose this option if you want to include several messages formatted as a stacked JSON in your events.

Extraction info

The extraction info defines what specific data elements should be extracted based on the selected strategy. Check the strategy descriptions above for more details.

General behavior

Parameter
Description

Propagate headers strategy

Choose between None (default option), Allow (enter the required header keys below), or All (all headers will be retrieved in the headers field).

Header keys

Enter the required header keys in this field. Click Add element for each one.

Exported headers format

Choose the required format for your headers.

Maximum message length

Maximum characters of the message. The default value is 4096.

Response code

Specify the response code to show when successful.

Response Content-Type

The Content-Type: xxx/xxx lets the server know the expected format of the incoming message or request (application/json by default):

  • Application/XML: the message body is formatted as XML.

  • Application/Json: the message body is formatted as JSON.

  • Text/Plain: the message body contains plain text.

  • Text/HTML: the message body contains HTML.

Response Text

The text that will show in case of success.

Click Create labels to move on to the next step and define the required Labels if needed.

PreviousGoogle Pub/SubNextHTTP Pull

Last updated

Was this helpful?