HTTP

Most recent version: v1.0.1

See the changelog of this Data sink type here.

Overview

Onum supports integration with HTTP.

HTTP, which stands for Hypertext Transfer Protocol, is a foundational protocol for communication on the World Wide Web. It defines how messages are formatted and transmitted between web servers and browsers, enabling the retrieval and display of webpages and other web content.

Select HTTP from the list of Data sink types and click Configuration to start.

Data sink configuration

Now you need to specify how and where to send the data, and how to establish a connection with HTTP.

Metadata

Enter the basic information for the new Data sink.

Parameters

Description

Name*

Enter a name for the new Data sink.

Description

Optionally, enter a description for the Data sink.

Tags

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

Metrics display

Decide whether or not to include this Data sink info in the metrics and graphs of the Home area.

Click Finish when complete. Your new Data sink will appear in the Data sinks area list.

Pipeline configuration

When it comes to using this Data sink in a Pipeline, you must configure the following output parameters. To do it, simply click the Data sink on the canvas and select Configuration.

Output configuration

Parameter

Description

HTTP method*

The method used to connect to the server.

URL*

The URL to send HTTP requests. This feature supports dynamic URLs allowing you to select an input field to generate it in real-time.

Message

Choose the field containing the message you wish to send on.

Content type

Set the request content type. Choose between:

text/plain - The message body contains plain text.
application/json - The message body is formatted as JSON. This is the default option.
application/xml - The message body is formatted as XML.

text/html - The message body contains HTML.
application/x-ndjson - The message body is formatted as NDJSON.

Support special characters

Set this to true to allow special characters in HTTP requests. Mostly used with application/x-ndjson content type.

HTTP headers

Map of header key-value pairs to be included in the request.

Bulk configuration

HTTP bulk configuration refers to setting up an API or system to handle multiple requests or large amounts of data efficiently in a single operation. Instead of sending multiple individual HTTP requests, use the bulk settings to send a single request containing numerous actions.

For example, this sends three user records in one request instead of three separate requests.

POST /api/bulk/users HTTP/1.1
Content-Type: application/json

[
  {"id": 1, "name": "Alice"},
  {"id": 2, "name": "Bob"},
  {"id": 3, "name": "Charlie"}
]

Parameter

Description

Bulk allow*

Set true to set a bulk amount or false to ignore.

Delimiter*

Optionally, choose a delimiter to separate the individual records in the bulk data file. Choose between:

Manual delimiter - Each record will appear on its own line. This is the default option. Enter the required delimiter in the Manual delimiter field that appears. The default value is \n
Json list - Use a comma (,) to separate individual JSON objects.

Maximum number of buffers per server URL*

Multiple buffers can be assigned to a single URL to prevent excessive memory usage. The default and maximim value is 50.

Event amount*

Enter the bulk amount to allow through.

Event time limit*

If the bulk amount is not reached, enter the seconds to wait before sending through the accumulated events.

Authentication configuration

Parameter

Description

Authentication type*

Choose the required authentication type:

None - Choose this if no authentication is required.

Basic - Enter the required Username and Password. Create a secret containing your password or select one already created.
Bearer - If you're using a bearer Token, create a secret containing it or select one already created.
API key - If you're using API credentials, enter your API key name and choose the required API key value. Create a secret containing your API key or select one already created.
OAuth2 - Choose if you want to set OAuth2 authentication. Set the following:
- OAuth URL* - OAuth server URL.
- OAuth method* - OAuth method used when sending requests to the server.
- Send body as - Select how to send the request body to the server From URL encoded or JSON).
- OAuth request body - Body that will be sent to auth server.
- OAuth token path* - Path to token in response body from auth server.
- Query key / Value pairs - Set of query keys and values. Use this also in case you are sending the request with From URL encoded content type.
- Header key / Value pairs - Set of header keys and values.