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

    Type Alias MessageCorrelationRequest

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

    name: string

    The message name as defined in the BPMN process

    tenantId?: TenantId

    the tenant for which the message is published

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

    The message variables as JSON document

    Settings
    Member Visibility

    On This Page
    Properties