Skip to main content

Start connecting an app

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

Creates a hosted connection attempt targeted by appSlug and returns its complete connect URL. Validate the parsed URL against the expected provider origin and path for the current attempt, then use it without reconstructing its token query. Treat the URL as a short-lived credential; read expiresAt, avoid caching/sharing it, and create a fresh attempt when appropriate. Do not assume a specific lifetime or single-use property unless qualified for the deployed provider.

For embedding, configure exact allowedOrigins. Correlate the returned state with the attempt initiated by this user; returned state is not authority. A redirect does not establish success: reconcile list-accounts and provider errors.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Let your assistant answer questions about a customer’s calendar

Request​

Responses​

Connect token and hosted link

Create a connection token for the authenticated end user using the configured provider defaults.​

Section ID: DOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#example-connected-apps-pipedreamCreateConnectToken-request

Request example

{}

Guide request for Create the authorization link when the customer clicks Connect. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#example-cookbook-integrations-tools-connections-connected-apps-02-request

Request example

{
  "appSlug": "google_calendar",
  "successRedirectUrl": "https://app.example.com/integrations?ok=1",
  "errorRedirectUrl": "https://app.example.com/integrations?ok=0",
  "state": "picker-session-8f3a"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#example-connected-apps-pipedreamCreateConnectToken-response

Response example

{
  "token": "example",
  "connectLinkUrl": "https://example.com/resource",
  "expiresAt": "2026-09-16T12:00:00Z"
}

Illustrative response for Create the authorization link when the customer clicks Connect. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#example-cookbook-integrations-tools-connections-connected-apps-json-02-response

Response example

{
  "token": "ctok_5xyz...",
  "connectLinkUrl": "https://pipedream.com/_static/connect.html?token=ctok_5xyz...&connectLink=true&app=google_calendar",
  "expiresAt": "2026-08-10T10:04:11Z"
}

Document ID: DOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken. Section identities and revisions.

SectionStable reference
Start connecting an appDOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#overview
RequestDOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#request
ResponsesDOC-IN-tools-connections-apps-api-pipedreamCreateConnectToken#responses