Skip to main content

Start connecting an app

POST 
/api/v1/integrations/pipedream/create-connect-token

Mints a short-lived Connect token and returns connectLinkUrl — a hosted page, already targeted at app_slug, where the user authorizes the connection. Open it in a browser, a web view, or an iframe; when the user finishes, the account exists and shows up in list-accounts.

Send app_slug. Without it the hosted page has nothing to connect and answers "Please include the app in the Connect URL". The returned link is complete — open it as given rather than rebuilding the query string.

The link is single-use and expires — currently about four hours out, but read expiresAt rather than assuming a window. Mint one per connection attempt at the moment the user asks to connect; do not cache them.

Embedding in an iframe requires allowed_origins — list the exact origins that will frame the page (https://app.example.com), or the browser blocks it. Omit it for a full-page redirect.

state is round-tripped back to your redirect untouched, so use it to correlate the return leg with whatever the user was doing. It is opaque to the platform — treat it as untrusted on the way back and never put a secret in it.

Request​

Responses​

Connect token and hosted link