Skip to content
LyftData Docs

MQTT

MQTT (mqtt)

Section titled “MQTT (mqtt)”

Publish events to external MQTT brokers or an embedded broker instance.

Messaging Enterprise edition binary json raw

Minimal example

Section titled “Minimal example”
output:
  mqtt: {}
JSON 
{
  "output": {
    "mqtt": {}
  }
}

Contents

Section titled “Contents”

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

Fields

Section titled “Fields”
Field Type Required Description
client Client Publisher Publish to an external MQTT broker.
broker Embedded Broker Publisher Publish into an embedded broker that serves downstream subscribers.

Schema

Section titled “Schema”

Client Publisher - Retry - Backoff Fields

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

Client Publisher - Retry Fields

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

Client Publisher - Tls Fields

Section titled “Client Publisher - Tls Fields”
Field Type Required Description
ca-certificate string Optional CA certificate (PEM encoded).
client-certificate string Optional client certificate (PEM encoded).
client-key string Optional client private key (PEM encoded).

Client Publisher - Dead Letter Fields

Section titled “Client Publisher - Dead Letter Fields”
Field Type Required Description
topic string ✅ Topic to publish failed messages to once retries are exhausted.
qos number QoS level for dead-letter publishes (0 or 1).
Default: 0
retain ✓ boolean (bool) Whether the dead-letter publish should retain the message.
Default: false

Client Publisher Fields

Section titled “Client Publisher Fields”
Field Type Required Description
retry Retry Retry policy for publish failures.
endpoint url (string) ✅ Broker endpoint URI (e.g. mqtt://broker:1883 or mqtts://broker:8883).
Examples: https://example.com/path
protocol Protocol MQTT protocol version used for publishing.
Allowed values: v3, v5
client-id string Optional client identifier override.
keep-alive-secs number (integer) Keep-alive interval in seconds.
Default: 30
Examples: 42, 1.2e-10
clean-session ✓ boolean (bool) Whether to request a clean session on connect.
Default: true
username string Optional username for broker authentication.
password string Optional password for broker authentication.
tls Tls TLS material for secure connections.
request-channel-capacity number (integer) Request channel capacity for the client worker.
Default: 10
Examples: 42, 1.2e-10
inflight number (integer) Maximum inflight window for QoS1 publishes.
Default: 100
Examples: 42, 1.2e-10
qos number Publish QoS level (0 or 1).
Default: 0
retain ✓ boolean (bool) Whether publishes should set the retain flag.
Default: false
topic string Static topic to publish to when dynamic selectors are absent.
topic-field field (string) Event field to resolve the topic from at runtime.
Examples: data_field
topic-pointer json-pointer (string) JSON pointer to resolve the topic from at runtime.
payload-mode Payload Mode Controls how event payloads are encoded prior to publish.
Default: auto
Allowed values: auto, json, raw, binary
pool-size number (integer) Number of MQTT client connections maintained for parallel publishing.
Default: 1
Examples: 42, 1.2e-10
response-topic string Optional response topic for MQTT v5 publishes.
correlation-data string Optional correlation data (base64 encoded) for MQTT v5 publishes.
message-expiry-interval-secs number (integer) Optional message expiry interval (seconds) for MQTT v5 publishes.
Examples: 42, 1.2e-10
dead-letter Dead Letter Dead-letter behaviour when retries are exhausted.

Embedded Broker Publisher - Retry - Backoff Fields

Section titled “Embedded Broker Publisher - 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

Embedded Broker Publisher - Retry Fields

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

Embedded Broker Publisher - Listeners Fields

Section titled “Embedded Broker Publisher - Listeners Fields”
Field Type Required Description
bind socket-address (string) ✅ Socket address in host:port form for the embedded broker listener.
Examples: localhost:443
tls ✓ boolean (bool) Whether TLS should be enabled for this listener (placeholder).
Default: false

Embedded Broker Publisher Fields

Section titled “Embedded Broker Publisher Fields”
Field Type Required Description
retry Retry Retry policy applied before surfacing broker publish failures.
qos number Publish QoS level (0 or 1).
Default: 0
retain ✓ boolean (bool) Whether embedded broker publishes should set the retain flag.
Default: false
topic string Static topic used when dynamic selectors are absent.
topic-field field (string) Event field to resolve the topic from.
Examples: data_field
topic-pointer json-pointer (string) JSON pointer to resolve the topic from.
payload-mode Payload Mode Controls how payloads are encoded prior to publish.
Default: auto
Allowed values: auto, json, raw, binary
listeners Listeners[] Listener surfaces to bind for the embedded broker.
persistence-path string Optional on-disk directory for broker persistence (defaults to job data dir).
topic-prefix string Optional prefix applied to topics before publishing into the embedded broker.
worker-threads number (integer) Number of worker threads dedicated to the embedded broker runtime.
Default: 1
Examples: 42, 1.2e-10

Client Publisher - Retry - Backoff - Strategy Options

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

Client Publisher - Protocol Options

Section titled “Client Publisher - Protocol Options”
Value Aliases Name Description
v3 v3
v5 v5

Client Publisher - Payload Mode Options

Section titled “Client Publisher - Payload Mode Options”
Value Aliases Name Description
auto auto
json json
raw raw
binary binary

Embedded Broker Publisher - Retry - Backoff - Strategy Options

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

Embedded Broker Publisher - Payload Mode Options

Section titled “Embedded Broker Publisher - Payload Mode Options”
Value Aliases Name Description
auto auto
json json
raw raw
binary binary