Skip to content

Correlation ID

A correlation ID links related messages within an operation. It can cover several events and does not replace duplicate detection.

APIs & Integration

A correlation ID associates related messages or processing steps with a shared operation. This allows a workflow to be followed across several participating systems. The application determines which messages belong together; that relationship needs to be agreed for the exchange.

Follow an operation through its messages

In a fictional portal, a request starts processing in the ERP. A receipt acknowledgement and the result return later. These messages have different identifiers of their own but share the agreed correlation ID. When investigating a fault, you can use it to bring together the messages for that request.

Distinguish a relationship from an identity

Microsoft describes the CorrelationId application property for this purpose; the spelling CorrelationId belongs to this example. Shared correlation does not make two messages duplicates. It also does not prove that the workflow is complete. Specify who creates the identifier, which transfers preserve it and which responses you need to assess the operation.

Sources

Articles on this topic

APIs & Integration with ASES

ERP, CRM and shop cleanly connected