Triggers – Cases

Get case session status

Returns the status and result of a session that was triggered for a specific test case.

get/api/triggers/cases/{caseId}/sessions/{sessionId}

Request

Path parameters

caseIdstring uuid required

UUID of the test case.

sessionIdstring uuid required

UUID of the session returned by the trigger endpoint.

Response

Session status.

idstring uuid required
status'queued' | 'created' | 'preparing' | 'running' | 'succeeded' | 'failed' | 'terminated' | 'error' | 'archived' required

Terminal statuses (stop polling): succeeded, failed, terminated, error, archived.

result'passed' | 'failed' | 'error' nullable
platform'desktop' | 'android' | 'ios' required
screenshotsCountinteger required
startedAtstring date-time nullable
completedAtstring date-time nullable
archivedAtstring date-time nullable

Set when the result was archived (soft-deleted); archived sessions stay readable here but are hidden from lists.

waitingForUserboolean

True while the run is parked on a [manual] step and waits for POST /api/sessions/{sessionId}/messages.

waitingForUserInstructionstring

The step's instruction, present only while waitingForUser is true.

Changes

No recorded changes to this operation across all 1 revision of this API.