Skip to main content
Version: 8.6

Correlate a message

POST 

/messages/correlation

Publishes a message and correlates it to a subscription. If correlation is successful it will return the first process instance key the message correlated with.

Request

Body

required
    name string

    The message name as defined in the BPMN process

    correlationKey string

    The correlation key of the message

    variables objectnullable

    The message variables as JSON document

    property name* anynullable

    Additional properties allowed.

    tenantId stringnullable

    the tenant for which the message is published

Responses

The message is correlated to one or more process instances

Schema
    messageKey int64

    The key of the correlated message

    tenantId string

    The tenant ID of the correlated message

    processInstanceKey int64

    The key of the first process instance the message correlated with

Loading...