Skip to content
Proud to collaborate with Microsoft for Startups

runner.workspace-lease.complete ​

Finalize a workspace lease as completed, blocked, failed, or abandoned.

Finalize a lease with a terminal outcome.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization; injected by the workflow API.
workspace_lease_uuiduuidYes—Workspace lease UUID.
executor_uuiduuidNo—Claim owner UUID. May be omitted only to abandon an unclaimed request after runner-launch compensation.
outcomestringYes——
head_oidstringNo——
failure_reasonstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
workspace_lease_uuiduuidNo——
organization_uuiduuidNo——
actor_uuiduuidNo——
agent_session_uuiduuidNo——
runner_execution_uuiduuidNo——
ticket_uuiduuidNo——
ticket_git_work_uuiduuidNo——
repository_uuiduuidNo——
statusstringNo——
executor_uuiduuidNo——
worktree_uuiduuidNo——
branch_refstringNo——
target_refstringNo——
base_oidstringNo——
head_oidstringNo——
claimed_atstringNo——
heartbeat_atstringNo——
completed_atstringNo——
failure_reasonstringNo——
extradictNo——
created_atstringNo——
updated_atstringNo——
failed_atstringNo——
outcomestringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "runner.workspace-lease.complete",
  "initial_data": {
    "organization_uuid": "value",
    "workspace_lease_uuid": "value",
    "outcome": "value"
  }
}