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

• Fields

• Processing

• Request

• Payload

• Reliability

• Security

• Schema

Fields

Field	Type	Required	Description
url Request	url (string)	✅	The URL may contain ${} field expansions. Examples: https://example.com/path
batch Processing	Batch		Collect input events together into batches.
body Payload	Body		How to construct the request body (event, field, or literal).
headers Request	map (string)		HTTP headers of the request.
idempotency-key-field Request	field (string)		Field providing the value for the Idempotency-Key header when supported by the sink. Examples: data_field
retry Reliability	Retry		How to retry failed requests.
insecure Security	boolean (bool)		Ignore TLS certificate validation errors (This is unsafe to use).
method Request	Method		HTTP method to use for the query (either ‘get’ or ‘post’). Allowed values: get, post, put, patch, delete, options, head

Processing

Show fields

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

Request

Show fields

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

Payload

Show fields

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

Reliability

Show fields

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

Security

Show fields

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

Schema

• Body Options
• Batch Fields
• Body - Field Fields
• Body - Literal Fields
• Retry Fields
• Headers Table
• Batch - Mode Options
• Method Options

Body Options

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

Batch Fields

Field	Type	Required	Description
fixed-size	number (integer)		maximum number of events in an output batch. 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). 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).
wrap-as-json	boolean (bool)		Format the output batch as a JSON array.

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.

Retry Fields

Field	Type	Required	Description
timeout	time-interval (string)	✅	timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h
retries	number (integer)		number of retries. Examples: 42, 1.2e-10

Headers Table

Header	Value
Header-Name	value

Value format: templated-text.

Batch - Mode Options

Value	Description
fixed	Fixed
document	Document

Method Options

Value	Description
get	Get
post	Post
put	Put
patch	Patch
delete	Delete
options	Options
head	Head