Documentation

Delay before retry.

Which identity is used as the inbox primary key for an IntegrationEvent.

• PreferIntegrationMessageId (default) — use the application-level messageId minted at the producer's outbox enqueue. EP-19 / EP-20 keep this id stable across publish retries, so it is the natural primary dedupe key for Kafka-delivered events.
• PreferSourceEventIdentity — use the sourceEventId of the private event that produced this integration event. Useful when a producer may emit the same logical fact under different messageIds (e.g. schema-upgrade republish), and the consumer wants those republishes collapsed to a single handler run.
• KafkaDeliveryIdentity — use the Kafka topic-partition-offset triple as the dedupe key. Fallback only when neither messageId nor source identity is available. This identifies one broker delivery, not one logical producer message: if a producer republishes the same logical message, Kafka assigns a new offset and this policy will not collapse the republish.
• CustomDedupeKey — caller supplies the key. Use only when the other policies cannot represent the identity scheme; the consuming service owns key collision resistance.

How much of the integration-event envelope the inbox persists on the success path.

The failure path always persists the full envelope because a failed inbox row is the operator's dead-letter record.

Lifecycle state of an inbox row.

• InboxProcessing — legacy on-disk state from older wrappers and reserved for future async paths. Current single-transaction intake inserts fresh successful rows directly as InboxCompleted.
• InboxCompleted — handler ran to completion; terminal.
• InboxFailed — handler signaled a permanent failure; terminal. The caller is responsible for operator action (dead-letter, manual retry).

The classified outcome of runInboxTransaction.

• 'InboxProcessed a' — first delivery; handler ran and returned a.
• InboxDuplicate — a previous delivery already completed; handler not run.
• InboxInProgress — a previous attempt is currently in-flight, or a legacy processing row was read. Current single-transaction intake does not commit processing rows. Treat as transient.
• InboxPreviouslyFailed — a previous attempt recorded a permanent failure. Operator should review before reprocessing.

Errors surfaced by the inbox wrapper that originate from the inbox itself rather than from the supplied handler.

One row read back from keiro_inbox.

Rows written with PersistDedupeOnly decode with an empty IntegrationEvent payloadBytes, no attributes, no trace context, and no schema reference. Identity, routing, source-event ids, occurrence time, and Kafka delivery metadata are still preserved.

Optional Kafka-delivery metadata recorded alongside an inbox row.

Used by KafkaDeliveryIdentity to compute the dedupe key, and stored on the row regardless of policy so operators can correlate the inbox record with Kafka logs. Not part of the EP-19 envelope.

Compute the inbox dedupe key for an integration event under the given policy plus optional Kafka delivery context. Returns Left when the policy demands a field the envelope does not carry (for example, PreferSourceEventIdentity on an envelope with no sourceEventId).