Session Management
Session lifecycle management
Public endpoint. Requires integration API key in api-key header.
API version (e.g., v1)
v1Possible values: Sprinto-issued integration identifier.
Caller-side correlation id
Session created
Unauthorized
Too Many Requests
POST /api/external/push/{version}/integrations/{integration_id}/sessions HTTP/1.1
Host: api.sprinto.com
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"client_reference_id": "text"
}{
"id": "text",
"integration_id": "text",
"state": "active",
"created_at": "2025-10-31T16:38:14.401Z",
"updated_at": "2025-10-31T16:38:14.401Z",
"expires_at": "2025-10-31T16:38:14.401Z",
"inactivity_timeout_seconds": 3600,
"accepted_records_total": 0,
"accepted_records_by_entity": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"last_error": "text"
}Returns state and counts of accepted rows so far (by entity and total).
API version (e.g., v1)
v1Possible values: Sprinto-issued integration identifier.
Session identifier returned by the session creation endpoint.
Session status
Unauthorized
Session not found
GET /api/external/push/{version}/integrations/{integration_id}/sessions/{session_id} HTTP/1.1
Host: api.sprinto.com
api-key: YOUR_API_KEY
Accept: */*
{
"id": "text",
"integration_id": "text",
"state": "active",
"created_at": "2025-10-31T16:38:14.401Z",
"updated_at": "2025-10-31T16:38:14.401Z",
"expires_at": "2025-10-31T16:38:14.401Z",
"inactivity_timeout_seconds": 3600,
"accepted_records_total": 0,
"accepted_records_by_entity": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"last_error": "text",
"accepted_batches": 0,
"retry_count": 0
}Close the session & start processing
Send apply to apply staged data or discard to discard. Processing retries once on Sprinto side.
API version (e.g., v1)
v1Possible values: Sprinto-issued integration identifier.
Session identifier returned by the session creation endpoint.
applyPossible values: Transition accepted; processing started (async)
Unauthorized
Session not found
Session not in a closable state
POST /api/external/push/{version}/integrations/{integration_id}/sessions/{session_id}/close HTTP/1.1
Host: api.sprinto.com
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"status": "apply"
}{
"id": "text",
"integration_id": "text",
"state": "active",
"created_at": "2025-10-31T16:38:14.401Z",
"updated_at": "2025-10-31T16:38:14.401Z",
"expires_at": "2025-10-31T16:38:14.401Z",
"inactivity_timeout_seconds": 3600,
"accepted_records_total": 0,
"accepted_records_by_entity": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"last_error": "text",
"accepted_batches": 0,
"retry_count": 0
}Last updated