Interface PublishStartMessageRequest<Variables>

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

Type Parameters

Variables = IProcessVariables

Index

Properties

correlationKey? messageId? name tenantId? timeToLive variables

Properties

`Optional`correlationKey

correlationKey?: string

`Optional`messageId

messageId?: string

Unique ID for this message

name

name: string

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

`Optional`tenantId

tenantId?: string

the tenantId for the message

timeToLive

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