Use the Tracking API when your integration flow runs outside Link and you want to use Link for tracking, logging, and error handling. Your application controls the flow and reports its activity to Link through either Tracking API or Async Tracking API .
Externally managed flows
The external application receives, transforms, routes, and delivers the data. It reports document and interchange metadata, files, progress, and failures to Link so that the activity can be inspected in Link tracking.
For example, an external integration can receive an order, transform it, and deliver it to an ERP system. It creates tracking records in Link, attaches relevant files, and reports completion or an error. Link provides visibility into that work while the external integration remains responsible for executing the flow and coordinating retries.
Error handling in Link
Reported exceptions can participate in Link's error handling, including configured error rules. This allows Link to handle the recorded error and its resulting tracking state according to the environment's configuration.
Keep the external application's processing outcome and Link's tracking state coordinated. A change made by an error rule in Link does not itself instruct the external application to repeat or continue its processing.
Choose an interface
|
Interface |
When to use it |
How tracking is recorded |
|---|---|---|
|
Your application can wait for tracking operations to complete and use the returned Link identifiers |
Calls perform tracking work synchronously and return their result |
|
|
Your application needs to submit events without waiting for their synchronization into Link |
Calls stage events; a scheduler task later performs the tracking work using the supplied entity GUIDs |
Both interfaces serve externally managed flows and can use Link's error handling. The difference is when tracking operations are performed and how related records are identified. With Async Tracking, error handling associated with a staged event occurs when that event is processed, rather than merely when the API accepts it.
The following guides describe each interface's permissions, setup, request sequence, and examples:
Difference from Async Flow
Async Flow is used when Link manages the overall flow, but an itinerary step delegates some processing to an external system. Link persists the flow while it waits for a callback, then resumes or handles the reported failure.
|
|
Tracking / Async Tracking |
Async Flow |
|---|---|---|
|
Overall flow is controlled by |
The external application |
Link |
|
External system's role |
Executes the integration flow and reports tracking events |
Performs the processing delegated by an itinerary step |
|
Link's role |
Tracking, logging, and configured error handling |
Orchestrating the flow, including waiting for and handling the external result |
|
Meaning of asynchronous behavior |
Deferred recording of tracking events in Async Tracking |
Waiting for external processing within a Link-managed flow |
Async Tracking is therefore not a callback interface for an itinerary step. For that scenario, use the existing Async HTTP itinerary step guide.