Skip to main content
Version: 8.10 (unreleased)

Type Alias: MessageSubscriptionResult

type MessageSubscriptionResult = object;

Properties​

correlationKey​

correlationKey: string | null;

The correlation key of the message subscription.

elementId​

elementId: ElementId;

The element ID associated with this message subscription.

elementInstanceKey​

elementInstanceKey: ElementInstanceKey | null;

The element instance key associated with this message subscription. Only populated for intermediate event entities.

inboundConnectorType​

inboundConnectorType: string | null;

Inbound connector type extracted from the inbound.type zeebe:property. Null when the property is absent.

lastUpdatedDate​

lastUpdatedDate: string;

The last updated date of the message subscription.

messageName​

messageName: string;

The name of the message associated with the message subscription.

messageSubscriptionKey​

messageSubscriptionKey: MessageSubscriptionKey;

The message subscription key associated with this message subscription.

messageSubscriptionState​

messageSubscriptionState: MessageSubscriptionStateEnum;

messageSubscriptionType​

messageSubscriptionType: MessageSubscriptionTypeEnum;

processDefinitionId​

processDefinitionId: ProcessDefinitionId;

The process definition ID associated with this message subscription.

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey | null;

The process definition key associated with this message subscription.

processDefinitionName​

processDefinitionName: string | null;

The name of the process definition associated with this message subscription.

processDefinitionVersion​

processDefinitionVersion: number | null;

The version of the process definition associated with this message subscription.

processInstanceKey​

processInstanceKey: ProcessInstanceKey | null;

The process instance key associated with this message subscription. Only populated for intermediate event entities.

rootProcessInstanceKey​

rootProcessInstanceKey: ProcessInstanceKey | null;

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

tenantId​

tenantId: TenantId;

toolName​

toolName: string | null;

Tool name extracted from the io.camunda.tool:name zeebe:property. Null when the property is absent.

toolProperties​

toolProperties: object;

The subset of zeebe:properties extension properties whose keys start with the io.camunda.tool: prefix, extracted from the BPMN element associated with this subscription. Empty object when no matching properties are defined.

Index Signature​

[key: string]: string