Skip to main content
POST
Create connect session
Requires an API key with the environment:connect_sessions:write scope. Learn more about API key scopes.
Creates a short-lived connect session (30m). The returned token can be used for instance to create connections through Connect UI. You can attach connection-level tags to the session via the tags field. These tags are copied onto the created connection and included in auth webhooks. Most apps start with these tags: end_user_id, end_user_email, organization_id.

Authorizations

Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
tags
object

Connection tags (key/value strings). Keys are normalized to lowercase.

end_user
object
deprecated

Deprecated, use tags instead

organization
object
deprecated

Deprecated, use tags instead

allowed_integrations
string[]

Filters which integrations the end user can interact with

integrations_config_defaults
object
overrides
object
webhook_url_override
string

Override the environment's webhook URLs for the connection created by this session. When set, that connection's webhooks are sent only to this URL (the environment's primary and secondary URLs are bypassed).

Response

Successfully created a connect session

data
object
required