Skip to content
Proud to collaborate with Microsoft for Startups

ticket.software-delivery.evidence-record ​

Append ordered native Git, test, PR, check, merge, release, build, migration, rollout, deployment, blocker, or recovery evidence.

Append one trusted, normalized delivery evidence record.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
delivery_uuidstringYes——
sequenceintegerYes——
idempotency_keystringYes——
kindstringYes—What this record is evidence OF. One of: session, runner, workspace, skill, git, test, publication, pull_request, check, approval, merge, release, package, image, build, migration, rollout, deployment, blocker, recovery. A coding session's command output -- the policy's required_commands, lint and test runs alike -- is kind test with the command name in role; there is no command_results kind. Use blocker for a condition that stopped the lane and recovery for what cleared it.
source_typestringYes—Which system produced the record: agent, runner, provider, platform, human.
rolestringNo—Which instance of the kind this is, so several records of one kind stay distinguishable: the command name for test evidence (ruff, test, diff_check), the check name for check evidence, the reviewer identity for approval, the blocker code for blocker. Free text, 128 chars.
source_uuidstringNo——
native_refstringNo——
conclusionstringNo—How it came out: success, failure, neutral, skipped, timed_out, cancelled, pending. Free text, 64 chars; the gate reads it, so use these words.
head_oidstringNo——
merge_oidstringNo——
observed_atdatetimeNo——
actor_typestringNo——
actor_uuidstringNo——
datajsonNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
deliverydictNo——
evidencedictNo——
createdbooleanNo——
organization_uuidstringNo—Input field preserved in workflow state.
delivery_uuidstringNo—Input field preserved in workflow state.
sequenceintegerNo—Input field preserved in workflow state.
idempotency_keystringNo—Input field preserved in workflow state.
kindstringNo—Input field preserved in workflow state.
source_typestringNo—Input field preserved in workflow state.
rolestringNo—Input field preserved in workflow state.
source_uuidstringNo—Input field preserved in workflow state.
native_refstringNo—Input field preserved in workflow state.
conclusionstringNo—Input field preserved in workflow state.
head_oidstringNo—Input field preserved in workflow state.
merge_oidstringNo—Input field preserved in workflow state.
observed_atdatetimeNo—Input field preserved in workflow state.
actor_typestringNo—Input field preserved in workflow state.
actor_uuidstringNo—Input field preserved in workflow state.
datajsonNo—Input field preserved in workflow state.
failed_atstringNo—ISO-8601 timestamp when action_fail recorded the failure
failure_reasonstringNo—Human-readable failure reason from action_fail
failure_typestringNo—Engine-stamped failure category
failed_actionstringNo—Engine-stamped action that raised
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerstringNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—executeAccepted
executingNoNo—completeApplying the mutation
completedNoYesYes—Done
failedNoYesNo—Failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedexecuteexecutingRun the mutation
executingcompletecompletedFinalize
* (any state)failfailedCatch-all failure

API Usage ​

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

{
  "workflow_type": "ticket.software-delivery.evidence-record",
  "initial_data": {
    "organization_uuid": "value",
    "delivery_uuid": "value",
    "sequence": 123,
    "idempotency_key": "value"
  }
}