Correlated Events

Correlated events are those events in which the CorrelationId is the same—events with the same CorrelationId are all part of the same service call.

When a query is executed with the executeGenericQuery operation, or registered with the registerQuery operation, the correlate parameter can be used to request that the query return not only the events that match the query, but also all correlated events.

This ability to return correlated events allows you to see all events that have been triggered within a service call. Note, however, that this can cause a large amount of data to be returned—use it only when necessary.