Skip to main content
Version: 0.2.0 (Latest)

HTTP connector

Class: http — JSON over HTTP as an outbound client. Sources poll a remote URL and publish to a stream; sinks subscribe to a stream and POST batches to a REST endpoint. Listen / webhook ingest is http_server, not this class.

Create and edit under Sources and Sinks. Advanced Settings may expose more runtime options depending on deployment and permissions.

Source and sink behavior​

RoleBehavior
SourceHTTP client (often GET polling) pulls JSON and emits events to the connector stream.
SinkHTTP client sends event batches to endpoint (typically POST).
StreamsUpstream processing must publish to the stream the sink subscribes to; the source writes the stream tasks consume (Streams).

Defaults (Core): if method is unset, GET for sources and POST for sinks.

Required fields​

Every connector row​

FieldRequiredNotes
nameYesDisplay name; id derived from it.
classYesMust be http.
streamYesResolved stream id.
typeYessource or sink from the screen used at create time.
configYesClass-specific object; see below.

Class http — required configuration​

SettingRequiredNotes
endpointYesHTTP(S) URL for poll or delivery.

Create connector​

  1. Open Sources or Sinks → Create.
  2. Set Class to HTTP, set name, stream behavior, and Enabled.
  3. Enter endpoint and method appropriate for poll vs delivery.
  4. Add auth, TLS, intervals, and batching from Common configuration when needed.
  5. Save, then wire the stream into tasks / pipelines.

Source (UI)​

Create New Source modal with Class HTTP: Endpoint and Method
The HTTP source connector form.
UI fieldConnector setting
Endpoint (required)endpoint
Methodmethod (e.g. GET for polling sources)

Sink (UI)​

Same Config layout on Create New Sink; titles and primary button differ.

HTTP connector Config: Endpoint and Method
The HTTP sink connector form.
UI fieldConnector setting
Endpoint (required)endpoint
Methodmethod (usually POST for sinks)

Configuration​

Request and delivery​

  • method, endpoint, interval_ms, timeout_seconds, retry_attempts — Poll cadence, verbs, and client behavior.

Authentication​

  • authentication — Bearer, basic, API key headers, and related fields for your IdP.

Payload batching​

  • batch — max_events, timeout_ms, max_bytes for grouped reads or posts.

Compression and TLS​

  • compression, compression_threshold, tls — Optional payload compression and HTTPS trust / mTLS.

Runtime behavior​

  • Connectors run after deployment; Disabled connectors do not call remote HTTP.
  • Sources respect poll intervals and timeouts; sinks flush batches per batch and retry policy.
  • Downstream stream wiring must match task sink_streams / source_stream expectations.

Performance and operational notes​

  • Keep timeouts below upstream SLAs; tune retry_attempts to avoid thundering herds.
  • Cap batch sizes to endpoint and body limits.
  • Use TLS verification in production; document any custom trust stores.