Skip to content
Proud to collaborate with Microsoft for Startups

github.push-record ​

Record push event for audit and auto-deploy triggering

Record push event in GitHubPush table

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringYes—Webhook delivery ID
repository_uuiduuidYes—Repository UUID
organization_uuidstringNo—Organization UUID (public)
branch_uuiduuidNo—Branch UUID (None if deleted)
refstringYes—Full ref
branch_namestringYes—Branch name
before_shastringNo—Before SHA
after_shastringYes—After SHA
head_commitdictNo—Head commit details
commitslistNo—Commits array
pusherdictNo—Pusher details
is_createdbooleanYes—Is new branch
is_deletedbooleanYes—Is deleted branch
is_forcedbooleanYes—Is forced push
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
push_record_uuidstringNo——
commit_countintegerNo——
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—
executingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecuteexecuting—
executingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "github.push-record",
  "initial_data": {
    "delivery_ref": "value",
    "repository_uuid": "value",
    "ref": "value",
    "branch_name": "value"
  }
}