Interface NotificationClientOptions

The deadline for establishing the connection, in milliseconds. Defaults to 10000.

Overrides the durable consumer name.

Defaults to notify-<listener>, which is the name the control plane creates when notifications are enabled. Set it only when binding to a consumer name reported by the control plane.

The listener whose events are consumed.

It is used to derive the durable consumer name and the per-listener inbox prefix, so it must not contain ., *, >, /, ``, or whitespace.

Receives non-fatal connection and decode errors.

Decode errors normally stop consumption because the same event would be redelivered forever. When this handler is set, it takes responsibility for the undecodable event and consumption continues. Connection errors are reported here while the transport reconnects automatically.

The handler runs on the consuming task and must return promptly. Do not throw from it; exceptions are ignored to keep the connection usable.

The listener API key secret. Treat it as a secret and do not log it.

TLS options used for a wss:// connection.

The client notification tier WebSocket URL, for example wss://notifications.mxraven.com. Only the ws: and wss: schemes are accepted.

The listener API key prefix, for example mxr_tx_ab12cd34ef56.

The notification tier authenticates with the same API key used for SMTP submission and recipient feedback.