Connect
Create Connect URL
Create a hosted Connect URL for a linked account.
POST
Create a hosted Connect URL. The request body is stashed (keyed by the session token, with a 3-day TTL) and a URL of the form
Issue a token with Generate Session Token.
{app_url}/connect/{token} is returned. Redirect your user there to launch the hosted Connect experience; the hosted page reads your stashed properties back via Get Hosted Properties.
Any JSON you put in the body is preserved verbatim — use it to pass context (company name, plan, theming, etc.) to the hosted page.
Authentication
Session token for the linked account. This endpoint accepts session-token auth only — an API key is rejected.Format:
Bearer YOUR_SESSION_TOKENQuery Parameters
The linked account the hosted page should act on.
Optional config to scope the hosted page to. When set, it is appended to the returned URL as
?config_id=....Body Parameters
Arbitrary JSON properties to stash for the hosted page. Returned verbatim by Get Hosted Properties.
Response
- 200 OK
The hosted Connect URL to redirect the user to.