Core Plugins and tasks SseRequest
CertifiedConsume Server-Sent Events (SSE) from an HTTP endpoint.
Core Plugins and tasks SseRequest
Consume Server-Sent Events (SSE) from an HTTP endpoint.
Connects to an SSE endpoint and consumes events. Optionally extracts and concatenates specific fields from event data using JQ.
SSE endpoints send events in the format:
data: {"field": "value"}
Use the concatJqExpression property to extract specific fields from each event's JSON data and concatenate them into a single string result.
type: io.kestra.plugin.core.http.SseRequestExamples
Consume SSE events from an endpoint and collect all events.
id: sse_consumer
namespace: company.team
tasks:
- id: consume_events
type: io.kestra.plugin.core.http.SseRequest
uri: https://example.com/events
maxEvents: 10
Consume SSE events and extract specific field using JQ, concatenating all values.
id: sse_with_JQ
namespace: company.team
tasks:
- id: consume_and_extract
type: io.kestra.plugin.core.http.SseRequest
uri: https://example.com/stream
concatJqExpression: $.message
Consume SSE events with authentication header.
id: sse_authenticated
namespace: company.team
tasks:
- id: auth_sse
type: io.kestra.plugin.core.http.SseRequest
uri: https://api.example.com/events
headers:
Authorization: 'Bearer {{ secret("API_TOKEN") }}'
concatJqExpression: $.data.value
Properties
uri *Requiredstring
The fully-qualified URI that points to the HTTP destination
body string
The full body as a string
concatJqExpression string
JQ expression to extract and concatenate values from event data.
When provided, this JQ expression will be applied to each event's, and the extracted values will be concatenated into a single string. If the path is not found in an event, that event will be skipped.
contentType string
application/jsonThe request content type
failedOnMissingJq booleanstring
If true, the task will fail if the JQ expression is provided but fails to extract a value from any event.
If false, events that do not match the JQ expression will be skipped without causing the task to fail. If true, the task will throw an exception if any event does not yield a value from the JQ expression. Default is true.
formData object
The form data to be send
headers object
The headers to pass to the request
method string
GETThe HTTP method to use
options Non-dynamic
{
"followRedirects": "true",
"allowFailed": "false",
"enabledTcpExtendedKeepAlive": "true",
"defaultCharset": "UTF-8"
}The HTTP request options
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
params object
The query string parameter to use
Adds parameter to URI query. The parameter name and value are expected to be unescaped and may contain non ASCII characters.
The value can be a string or a list of strings.
This method will not override parameters already existing on uri and will add them as array.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
events array
List of all events received
Each event contains the json data or raw data field content from the SSE stream.. Will be null if JQ was provided.
io.kestra.core.http.HttpSseEvent
durationresult string
Concatenated result from JQ extraction
If concatJqExpression was provided, this contains all extracted values concatenated into a single string. Will be null if no JQ was provided.
size integer
Total number of events received
uri string
uriThe URL of the SSE endpoint
Metrics
size counter
The number of events received
