@camunda8/sdk
    Preparing search index...

    Interface PublishMessageRequest<Variables>

    interface PublishMessageRequest<Variables = IInputVariables> {
        correlationKey: string;
        messageId?: string;
        name: string;
        tenantId?: string;
        timeToLive?: MaybeTimeDuration;
        variables?: Variables;
    }

    Type Parameters

    Index

    Properties

    correlationKey messageId? name tenantId? timeToLive? variables?

    Properties

    correlationKey: string

    The value to match with the field specified as "Subscription Correlation Key" in BPMN

    messageId?: string

    Unique ID for this message

    name: string

    Should match the "Message Name" in a BPMN Message Catch

    tenantId?: string

    the tenantId of the message

    timeToLive?: MaybeTimeDuration

    The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering.

    variables?: Variables

    Settings

    Member Visibility

    On This Page

    Properties