Skip to navigation
Sessions Management

Get Session State

View as Markdown

Retrieve the current execution state, lifecycle status, and active cursor screen of the flow session.

This endpoint allows synchronous checking of a session’s progress. While webhooks are the recommended asynchronous way to track status updates — they are configured once per application in the Console, not per session — this endpoint is useful for clients that want to keep their backend state synchronized with INFONITE.

Common use cases include:

  • Polling for session completion or terminal failure status when webhooks are not implemented.
  • Retrieving the active cursor/screen to display progress or updates in client dashboards.
  • Recovering and synchronizing the final session state if a connection is lost during the flow.
A session is finished only when is_closed is true

If polling, poll this endpoint for is_closed, not for anything else. While it is false the session is still alive — even if the customer left, even if the widget closed, even if you already received partial results. A source may still be working in the background (the CIRBE report from the Banco de España is the usual case), and records can still change or appear.

status_code alone is not the answer: a session sitting on WAITING with the cursor at es-public-administration:connect:wait is unfinished by design, not stuck.

Once the session is closed, status_code says who ended it — your customer, you, or the platform — and why: How a session ends.

This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

session_idstringRequiredformat: "object-id"
Session ID to fetch

Response

200 OK
The session is FINISHED and nothing about it will change.

kind"es-public-administration"

The flow type identifier, always ‘es-public-administration’.

cursorenum
The current screen identifier where the user is positioned in the widget experience.
session_idstringformat: "object-id"
The unique database identifier of this flow session.
app_idstringformat: "object-id"
The identifier of the client application that owns this session.
customer_idstring1-64 characters
The external customer reference provided by the client application.
status_codeenum

The status of the session: READY while the person is in the widget, WAITING once they have left and a read still runs in the background (the Banco de España’s report is the usual one). Any other status is final.

date_createdstringformat: "datetime"
The timestamp when this flow session was created.
date_limitstringformat: "datetime"

The deadline by which the session must be completed by the user. Always present — 12 hours after creation when you did not ask for another.

expiration_datestringformat: "datetime"

The timestamp when this session record will be auto-deleted from the database.

is_closedbooleanRead-only
Indicates if the flow session has been finalized or closed.
status_messagestringOptional
An informative status message describing the current session state.
date_startedstringOptionalformat: "datetime"
The timestamp when the customer opened the session widget.
ping_datestringOptionalformat: "datetime"
The timestamp of the last customer interaction or heartbeat.
date_endedstringOptionalformat: "datetime"
The timestamp when the flow session was finalized or closed.
end_hookenumOptional
Delivery status of the final webhook event callback.

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
504
Gateway Timeout Error