SDK reference
Core concepts

Linking related runs

Explicitly associate executions across requests and services.

Continue the same run by passing the same workflow() name and id. Use the links below when later work is a separate execution you want to group.

Group by correlation ID

Pass the same correlationId to runs that belong to the same application-defined process. You choose and pass the value.

const run = flowmark.workflow("order.fulfill", {
  correlationId: requestGroupId,
  properties: { orderId },
})

Declare a parent

Pass a parent's external SDK runId through your own application request or job payload, then set parentRunId on the child:

const child = flowmark.workflow("shipment.create", {
  correlationId: requestGroupId,
  parentRunId: upstreamRunId,
})

Pass parentRunId through your own request or job payload. Use the parent's external SDK runId, not the dashboard's internal UUID.

Lookup behavior

The dashboard queries related runs within the same project. Parent lookup can return no match if the parent has not arrived or is missing. Repeated external IDs across workflows can produce multiple matches. Correlation lookup includes matching runs outside the overview's latest-100 snapshot.

These links are application declarations, not proof of causation. Browser-supplied values are untrusted and must not be used for identity or authorization.

Bounds

Correlation IDs must be nonblank strings up to 128 characters; parent IDs are nonblank strings up to 200 characters. Keep both non-sensitive. See workflow() and run.related.

On this page