@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias MessagePublicationRequest

    type MessagePublicationRequest = {
        businessId?: BusinessId;
        correlationKey?: string;
        messageId?: string;
        name: string;
        tenantId?: TenantId;
        timeToLive?: number;
        variables?: { [key: string]: unknown };
    }
    Index
    businessId? correlationKey? messageId? name tenantId? timeToLive? variables?
    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?: string

    The correlation key of the message.

    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: string

    The name of the message.

    tenantId?: TenantId

    The tenant of the message sender.

    timeToLive?: number

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

    variables?: { [key: string]: unknown }

    The message variables as JSON document.

    Settings
    Member Visibility

    On This Page
    Properties