Links

Links are the core abstraction in the Connect Service — a lightweight intent to connect a user’s account.

What is a link?

A link represents a request to connect a user’s account with a specific provider. Inspired by Plaid’s link_token pattern, links are cheap to create and only spawn sessions when claimed.

Lifecycle

1. Created — POST /v1/links creates a link record with a claim code
2. Claimed — The client SDK calls POST /link/claim with the claim code, creating a session and starting the automation
3. Completed — The automation finishes successfully; result data is stored on the link
4. Failed — The automation encountered an error; the link can be re-claimed for a new attempt

Re-claiming

If a link fails, the user can try again. Each claim creates a new session — the link itself persists across attempts.

Single-use on success

Once a link completes successfully, it cannot be re-claimed. Create a new link for subsequent account connections.

Next steps

• Sessions — What happens after a link is claimed
• Create Link API — API reference