Redis

Redis (redis)

Publish events to Redis Pub/Sub or append them to Redis Streams.

Messaging Enterprise edition binary json raw

Minimal example

output:
  redis: {}

JSON

{
  "output": {
    "redis": {}
  }
}

Contents

• Minimal example

• Fields

• Schema

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

Fields

Field	Type	Required	Description
publish	Publish
stream	Stream

Schema

• Publish - Retry - Backoff Fields
• Publish - Retry Fields
• Publish Fields
• Stream - Retry - Backoff Fields
• Stream - Retry Fields
• Stream Fields
• Publish - Retry - Backoff - Strategy Options
• Publish - Payload Mode Options
• Stream - Retry - Backoff - Strategy Options
• Stream - Payload Mode Options

Publish - 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

Publish - 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.

Publish Fields

Field	Type	Required	Description
address	url (string)	✅	Redis endpoint URI (for example redis://localhost:6379/0 or rediss://cache:6380/0). Examples: https://example.com/path
username ✓	string		Optional username override when the URI does not embed credentials.
password ✓	string		Optional password override when the URI does not embed credentials.
database	number (integer)		Optional database index override when the URI does not select a database. Examples: 42, 1.2e-10
retry	Retry		Retry policy for publish failures.
channel	string		Static Redis channel used when dynamic selectors are absent.
channel-field	field (string)		Event field containing the target Redis channel. Examples: data_field
channel-pointer	json-pointer (string)		JSON pointer resolving to the target Redis channel.
payload-mode	Payload Mode		Controls how the event is serialized before PUBLISH. Default: auto Allowed values: auto, json, raw, binary

Stream - 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

Stream - 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.

Stream Fields

Field	Type	Required	Description
address	url (string)	✅	Redis endpoint URI (for example redis://localhost:6379/0 or rediss://cache:6380/0). Examples: https://example.com/path
username ✓	string		Optional username override when the URI does not embed credentials.
password ✓	string		Optional password override when the URI does not embed credentials.
database	number (integer)		Optional database index override when the URI does not select a database. Examples: 42, 1.2e-10
retry	Retry		Retry policy for stream append failures.
stream	string		Static Redis stream key used when dynamic selectors are absent.
stream-field	field (string)		Event field containing the target Redis stream key. Examples: data_field
stream-pointer	json-pointer (string)		JSON pointer resolving to the target Redis stream key.
payload-mode	Payload Mode		Controls how the event is serialized before XADD. Default: auto Allowed values: auto, json, raw, binary
payload-field	field (string)		Stream field name used to store the logical payload. Default: payload Examples: data_field
entry-id	string		Entry id passed to XADD (* means auto-generated by Redis). Default: *
maxlen	number (integer)		Optional MAXLEN trim hint for stream appends. Examples: 42, 1.2e-10
approximate-maxlen ✓	boolean (bool)		Whether MAXLEN should use approximate trimming. Default: false

Publish - Retry - Backoff - Strategy Options

Value	Aliases	Name	Description
exponential		exponential
linear		linear
fixed		fixed

Publish - Payload Mode Options

Value	Aliases	Name	Description
auto		auto
json		json
raw		raw
binary		binary

Stream - Retry - Backoff - Strategy Options

Value	Aliases	Name	Description
exponential		exponential
linear		linear
fixed		fixed

Stream - Payload Mode Options

Value	Aliases	Name	Description
auto		auto
json		json
raw		raw
binary		binary