Create a connect session

Create a new connect session

POST /connect/sessions

Create connect session

cURL

curl --request POST \
  --url https://api.nango.dev/connect/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": {},
  "allowed_integrations": [
    "<string>"
  ],
  "integrations_config_defaults": {},
  "overrides": {}
}
'

import requests

url = "https://api.nango.dev/connect/sessions"

payload = {
    "tags": {},
    "allowed_integrations": ["<string>"],
    "integrations_config_defaults": {},
    "overrides": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tags: {},
    allowed_integrations: ['<string>'],
    integrations_config_defaults: {},
    overrides: {}
  })
};

fetch('https://api.nango.dev/connect/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nango.dev/connect/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tags' => [
        
    ],
    'allowed_integrations' => [
        '<string>'
    ],
    'integrations_config_defaults' => [
        
    ],
    'overrides' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/connect/sessions"

	payload := strings.NewReader("{\n  \"tags\": {},\n  \"allowed_integrations\": [\n    \"<string>\"\n  ],\n  \"integrations_config_defaults\": {},\n  \"overrides\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nango.dev/connect/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tags\": {},\n  \"allowed_integrations\": [\n    \"<string>\"\n  ],\n  \"integrations_config_defaults\": {},\n  \"overrides\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/connect/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tags\": {},\n  \"allowed_integrations\": [\n    \"<string>\"\n  ],\n  \"integrations_config_defaults\": {},\n  \"overrides\": {}\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": {
    "token": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "connect_link": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

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.

Show child attributes

end_user · object · deprecated

Deprecated, use tags instead

Show child attributes

organization · object · deprecated

Deprecated, use tags instead

Show child attributes

allowed_integrations · string[]

Filters which integrations the end user can interact with

integrations_config_defaults · object

Show child attributes

overrides · object

Show child attributes

Response

201

application/json

Successfully created a connect session

data · object · required

Show child attributes