Create a session - Dromo Docs

POST

/

auth

/

Create a session

curl --request POST \
  --url https://app.dromo.io/api/widget/session/v2/auth/ \
  --header 'Content-Type: application/json' \
  --header 'X-DROMO-LICENSE-KEY: <api-key>' \
  --data '
{
  "import_identifier": "user_import_v1",
  "expires_in": 3600
}
'

import requests

url = "https://app.dromo.io/api/widget/session/v2/auth/"

payload = {
    "import_identifier": "user_import_v1",
    "expires_in": 3600
}
headers = {
    "X-DROMO-LICENSE-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DROMO-LICENSE-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({import_identifier: 'user_import_v1', expires_in: 3600})
};

fetch('https://app.dromo.io/api/widget/session/v2/auth/', 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://app.dromo.io/api/widget/session/v2/auth/",
  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([
    'import_identifier' => 'user_import_v1',
    'expires_in' => 3600
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DROMO-LICENSE-KEY: <api-key>"
  ],
]);

$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://app.dromo.io/api/widget/session/v2/auth/"

	payload := strings.NewReader("{\n  \"import_identifier\": \"user_import_v1\",\n  \"expires_in\": 3600\n}")

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

	req.Header.Add("X-DROMO-LICENSE-KEY", "<api-key>")
	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://app.dromo.io/api/widget/session/v2/auth/")
  .header("X-DROMO-LICENSE-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"import_identifier\": \"user_import_v1\",\n  \"expires_in\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dromo.io/api/widget/session/v2/auth/")

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

request = Net::HTTP::Post.new(url)
request["X-DROMO-LICENSE-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"import_identifier\": \"user_import_v1\",\n  \"expires_in\": 3600\n}"

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

{
  "sessionId": "1b6acf28-8748-4120-8d7a-4b7846d5e487",
  "hydrationId": "<signed-token>",
  "expiresIn": 21600,
  "savedAt": "2026-06-19T18:00:00.000Z"
}

Authorizations

X-DROMO-LICENSE-KEY

string

header

required

Your backend license key (is_for_backend_api=True) from the Dromo Dashboard. Never expose this client-side.

Body

application/json

import_identifier

string

A label for your own bookkeeping (e.g. schema name, import type). Not used for lookups. Defaults to "".

Example:

"user_import_v1"

expires_in

integer

Hydration token TTL in seconds. Defaults to 21600 (6 hours).

Example:

3600

Response

201 - application/json

Session created

sessionId

string<uuid>

Backend session identifier. Persist this durably — needed to resume the session or delete it later.

Example:

"1b6acf28-8748-4120-8d7a-4b7846d5e487"

hydrationId

string

Short-lived access token. Pass this to the widget to start or resume the session.

Example:

"<signed-token>"

expiresIn

integer

Seconds until the hydrationId expires.

Example:

21600

savedAt

string<date-time>

Example:

"2026-06-19T18:00:00.000Z"

Resume a session (re-issue hydrationId)Issues a fresh `hydrationId` for an existing session. Call this server-side when the user returns after their previous token has expired. The new token must belong to the same org as the session.

⌘I

Create a session

curl --request POST \
  --url https://app.dromo.io/api/widget/session/v2/auth/ \
  --header 'Content-Type: application/json' \
  --header 'X-DROMO-LICENSE-KEY: <api-key>' \
  --data '
{
  "import_identifier": "user_import_v1",
  "expires_in": 3600
}
'

import requests

url = "https://app.dromo.io/api/widget/session/v2/auth/"

payload = {
    "import_identifier": "user_import_v1",
    "expires_in": 3600
}
headers = {
    "X-DROMO-LICENSE-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DROMO-LICENSE-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({import_identifier: 'user_import_v1', expires_in: 3600})
};

fetch('https://app.dromo.io/api/widget/session/v2/auth/', 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://app.dromo.io/api/widget/session/v2/auth/",
  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([
    'import_identifier' => 'user_import_v1',
    'expires_in' => 3600
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DROMO-LICENSE-KEY: <api-key>"
  ],
]);

$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://app.dromo.io/api/widget/session/v2/auth/"

	payload := strings.NewReader("{\n  \"import_identifier\": \"user_import_v1\",\n  \"expires_in\": 3600\n}")

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

	req.Header.Add("X-DROMO-LICENSE-KEY", "<api-key>")
	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://app.dromo.io/api/widget/session/v2/auth/")
  .header("X-DROMO-LICENSE-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"import_identifier\": \"user_import_v1\",\n  \"expires_in\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dromo.io/api/widget/session/v2/auth/")

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

request = Net::HTTP::Post.new(url)
request["X-DROMO-LICENSE-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"import_identifier\": \"user_import_v1\",\n  \"expires_in\": 3600\n}"

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

{
  "sessionId": "1b6acf28-8748-4120-8d7a-4b7846d5e487",
  "hydrationId": "<signed-token>",
  "expiresIn": 21600,
  "savedAt": "2026-06-19T18:00:00.000Z"
}