Skip to content
LyftData Docs

HTTP Get

HTTP Get (http-get)

Section titled “HTTP Get (http-get)”

Send event data to a remote server using GET.

Http json

Minimal example

Section titled “Minimal example”
output:
  http-get:
    url: ""
JSON 
{
  "output": {
    "http-get": {
      "url": ""
    }
  }
}

Contents

Section titled “Contents”

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

Payload

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

Processing

Section titled “Processing”
Processing
Field Type Required Description
batch Batch Collect input events together into batches.

Reliability

Section titled “Reliability”
Reliability
Field Type Required Description
retry Retry How to retry failed requests.

Request

Section titled “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

Security

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

Schema

Section titled “Schema”

Body Options

Section titled “Body Options”
Option Name Type Description
event Event map
field Field object
literal Literal object

Body - Field Fields

Section titled “Body - Field Fields”
Field Type Required Description
field string ✅

Body - Literal Fields

Section titled “Body - Literal Fields”
Field Type Required Description
value string ✅ Literal/template request body; supports ${} expansions and multiline YAML strings.

Batch Fields

Section titled “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

Section titled “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

Section titled “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.

Headers Table

Section titled “Headers Table”
Header Value
Header-Name value

Value format: templated-text.

Batch - Mode Options

Section titled “Batch - Mode Options”
Value Aliases Name Description
fixed fixed
document document

Retry - Backoff - Strategy Options

Section titled “Retry - Backoff - Strategy Options”
Value Aliases Name Description
exponential exponential
linear linear
fixed fixed