Skip to content

HTTP Post

HTTP Post (http-post)

POST event data to an HTTPS server.

Http json

Minimal example

output:
http-post:
url: ""
JSON
{
"output": {
"http-post": {
"url": ""
}
}
}

Contents

Payload

Payload
FieldTypeRequiredDescription
bodyBodyHow to construct the request body (event, field, or literal).
Allowed values: event, field, literal

Processing

Processing
FieldTypeRequiredDescription
batchBatchCollect input events together into batches.

Reliability

Reliability
FieldTypeRequiredDescription
retryRetryHow to retry failed requests.

Request

Request
FieldTypeRequiredDescription
urlurl (string)The URL may contain ${} field expansions.
Examples: https://example.com/path
headersmap (string)HTTP headers of the request.
idempotency-key-fieldfield (string)Field providing the value for the Idempotency-Key header when supported by the sink.
Examples: data_field
methodMethodHTTP method to use for the query (either ‘get’ or ‘post’).
Allowed values: get, post, put, patch, delete, options, head

Security

Security
FieldTypeRequiredDescription
insecureboolean (bool)Ignore TLS certificate validation errors (This is unsafe to use).
Default: false

Schema

Body Options

OptionNameTypeDescription
eventEventmap
fieldFieldobject
literalLiteralobject

Body - Field Fields

FieldTypeRequiredDescription
fieldstring

Body - Literal Fields

FieldTypeRequiredDescription
valuestringLiteral/template request body; supports ${} expansions and multiline YAML strings.

Batch Fields

FieldTypeRequiredDescription
fixed-sizenumber (integer)maximum number of events in an output batch.
Examples: 42, 1.2e-10
modeModeIf ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
Allowed values: fixed, document
timeouttime-interval (string)interval after which the batch is sent, to keep throughput going (default 100ms).
Default: 100ms
Examples: 500ms, 2h
headermultiline-text (string)put a header line before the batch.
footermultiline-text (string)put a header line after the last line of the batch.
use-document-markerboolean (bool)Enrich the job metadata with a document marker (for document handling in batch mode).
Default: false
wrap-as-jsonboolean (bool)Format the output batch as a JSON array.
Default: false

Retry Fields

FieldTypeRequiredDescription
timeouttime-interval (string)timeout (e.g. 500ms, 2s etc. - default is 30).
Examples: 500ms, 2h
retriesnumber (integer)number of retries.
Examples: 42, 1.2e-10

Headers Table

HeaderValue
Header-Namevalue

Value format: templated-text.

Batch - Mode Options

ValueNameDescription
fixedfixedFixed
documentdocumentDocument

Method Options

ValueNameDescription
getgetGet
postpostPost
putputPut
patchpatchPatch
deletedeleteDelete
optionsoptionsOptions
headheadHead