For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: MessagePublicationRequest

type MessagePublicationRequest = object;

Properties​

businessId?​

optional businessId?: BusinessId;

An optional business id used to enforce uniqueness of the process instance that a message start event would create. If provided and uniqueness enforcement is enabled, the engine rejects starting a new process instance when another root process instance with the same business id is already active for the same process definition. It has no effect when the message correlates to a catch, boundary, or intermediate event.

correlationKey?​

optional correlationKey?: string;

The correlation key of the message.

messageId?​

optional messageId?: string;

The unique ID of the message. This is used to ensure only one message with the given ID will be published during the lifetime of the message (if timeToLive is set).

name​

name: string;

The name of the message.

tenantId?​

optional tenantId?: TenantId;

The tenant of the message sender.

timeToLive?​

optional timeToLive?: number;

Timespan (in ms) to buffer the message on the broker.

variables?​

optional variables?: object;

The message variables as JSON document.

Index Signature​

[key: string]: unknown