SseRequest
Consume Server-Sent Events (SSE) from an HTTP endpoint.
SseRequest
Consume Server-Sent Events (SSE) from an HTTP endpoint.
yaml
type: "io.kestra.plugin.core.http.SseRequest"Examples
yaml
id: sse_consumer
namespace: company.team
tasks:
- id: consume_events
type: io.kestra.plugin.core.http.SseRequest
uri: https://example.com/events
maxEvents: 10
yaml
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
yaml
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
body string
concatJqExpression string
contentType string
Default
application/jsonfailedOnMissingJq booleanstring
formData object
headers object
SubTypestring
method string
Default
GEToptions Non-dynamic
Default
{
"followRedirects": "true",
"allowFailed": "false",
"defaultCharset": "UTF-8"
} Definitions
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailedbooleanstring
Default
falseallowedResponseCodesarray
SubTypeinteger
auth
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type*Requiredobject
tokenstring
io.kestra.core.http.client.configurations.DigestAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
basicAuthPasswordDeprecatedstring
basicAuthUserDeprecatedstring
connectTimeoutDeprecatedstring
Format
durationconnectionPoolIdleTimeoutDeprecatedstring
Format
durationdefaultCharsetstring
Default
UTF-8java.nio.charset.Charset
followRedirectsbooleanstring
Default
truelogLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDlogsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYmaxContentLengthDeprecatedinteger
proxy
io.kestra.core.http.client.configurations.ProxyConfiguration
addressstring
passwordstring
portintegerstring
typestring
Default
DIRECTPossible Values
DIRECTHTTPSOCKSusernamestring
proxyAddressDeprecatedstring
proxyPasswordDeprecatedstring
proxyPortDeprecatedinteger
proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKSproxyUsernameDeprecatedstring
readIdleTimeoutDeprecatedstring
Format
durationreadTimeoutDeprecatedstring
Format
durationssl
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificatesbooleanstring
timeout
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeoutstring
readIdleTimeoutstring
Default
PT5Mparams object
Outputs
events array
Definitions
io.kestra.core.http.HttpSseEvent
commentstring
dataobject
idstring
namestring
retrystring
Format
durationresult string
size integer
uri string
Format
uri