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

• Minimal example

• Payload

• Processing

• Reliability

• Request

• Response

• Security

• Schema

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Payload

Payload

Field	Type	Required	Description
body	Body		How to construct the request body (event, field, or literal). Allowed values: event, field, literal

Processing

Processing

Field	Type	Required	Description
batch	Batch		Collect input events together into batches.

Reliability

Reliability

Field	Type	Required	Description
retry	Retry		How to retry failed requests.

Request

Request

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

Response

Response

Field	Type	Required	Description
acknowledgement	Acknowledgement		Optional provider acknowledgement contract evaluated after a successful HTTP status.

Security

Security

Field	Type	Required	Description
insecure ✓	boolean (bool)		Ignore TLS certificate validation errors (This is unsafe to use). Default: false

Schema

• Body Options
• Body - Field Fields
• Body - Literal Fields
• Batch Fields
• Retry - Backoff Fields
• Retry Fields
• Acknowledgement Fields
• Headers Table
• Batch - Mode Options
• Retry - Backoff - Strategy Options
• Method Options
• Acknowledgement - Expected Count Options

Body Options

Option	Name	Type	Description
event	Event	map
field	Field	object
literal	Literal	object

Body - Field Fields

Field	Type	Required	Description
field	string	✅

Body - Literal Fields

Field	Type	Required	Description
value	string	✅	Literal/template request body; supports ${} expansions and multiline YAML strings.

Batch Fields

Field	Type	Required	Description
fixed-size ✓	number (integer)		maximum number of events in an output batch. Examples: 42, 1.2e-10
max-bytes ✓	number (integer)		Close the batch before adding an event that would make the serialized request payload exceed this many bytes. Examples: 42, 1.2e-10
mode	Mode	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size. Allowed values: fixed, document
timeout	time-interval (string)	✅	interval after which the batch is sent, to keep throughput going (default 100ms). Default: 100ms Examples: 500ms, 2h
header	multiline-text (string)		put a header line before the batch.
footer	multiline-text (string)		put a header line after the last line of the batch.
use-document-marker ✓	boolean (bool)		Enrich the job metadata with a document marker (for document handling in batch mode). Default: false
wrap-as-json ✓	boolean (bool)		Format the output batch as a JSON array. Default: false

Retry - Backoff Fields

Field	Type	Required	Description
strategy	Strategy		Backoff strategy to use (default exponential). Allowed values: exponential, linear, fixed
base	string		Base delay before retrying (e.g. “200ms”).
max	string		Maximum delay between retries.
jitter ✓	boolean (bool)		Whether to add jitter to retry delays. Default: false

Retry Fields

Field	Type	Required	Description
max-attempts	number (integer)		Maximum attempts before giving up. Examples: 42, 1.2e-10
forever ✓	boolean (bool)		Retry indefinitely until cancelled. Default: false
backoff	Backoff		Backoff strategy configuration.

Acknowledgement Fields

Field	Type	Required	Description
accepted-count-pointer	json-pointer (string)	✅	JSON Pointer to the non-negative number of accepted request items.
failed-count-pointer	json-pointer (string)	✅	JSON Pointer to the non-negative number of rejected request items.
failure-items-pointer	json-pointer (string)		Optional JSON Pointer to an array of bounded provider failure codes.
max-response-bytes	number (integer)	✅	Maximum acknowledgement response body accepted for validation. Examples: 42, 1.2e-10
expected-count	Expected Count		How to derive the exact item count from the serialized request body. Allowed values: one, json-array, ndjson

Headers Table

Header	Value
Header-Name	value

Value format: templated-text.

Batch - Mode Options

Value	Aliases	Name	Description
fixed		fixed
document		document

Retry - Backoff - Strategy Options

Value	Aliases	Name	Description
exponential		exponential
linear		linear
fixed		fixed

Method Options

Value	Aliases	Name	Description
get		get
post		post
put		put
patch		patch
delete		delete
options		options
head		head

Acknowledgement - Expected Count Options

Value	Aliases	Name	Description
one		one
json-array		json-array
ndjson		ndjson