v1

latestOpenAPI 3.0.42026-08-0462132372.2 KB

Create Connect token

Generate a Connect token to use for client-side authentication

post/v1/connect/{project_id}/tokens

Headers

x-pd-environment'development' | 'production' required

The environment in which the server client is running

The environment in which the server client is running

Request body

allowed_originsstring[]

List of allowed origins for CORS

error_redirect_uristring

URI to redirect to on error

expires_ininteger

Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.

external_user_idstring required

Your end user ID, for whom you're creating the token

scopestring

Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.

success_redirect_uristring

URI to redirect to on success

webhook_uristring

Webhook URI for notifications

allow_progressive_scopesboolean

When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.

Response

connect token created

connect_link_urlstring required

The Connect Link URL

expires_atstring date-time required

The expiration time of the token in ISO 8601 format

tokenstring required

An authentication token with a limited lifespan