Skip to content
Proud to collaborate with Microsoft for Startups

github.deployment-complete ​

Complete deployment workflow

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
github_deployment_refintegerYes—GitHub deployment ID
deployment_numberstringNo—Deployment node ID
environmentstringNo—Environment
statusstringYes—Deployment status
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
github_deployment_refintegerNo—GitHub deployment ID
deployment_numberstringNo—Deployment node ID
environmentstringNo—Environment
statusstringNo—Deployment status
completed_atstringNo—Completed timestamp
workflow_run_idstringNo—Parent DAG run ID
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
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": "github.deployment-complete",
  "initial_data": {
    "github_deployment_ref": 123,
    "status": "value"
  }
}