Skip to content
Proud to collaborate with Microsoft for Startups

github.deployment-sync ​

Sync deployment event for audit

Sync deployment event (log for audit)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actionstringYes—Deployment action
event_typestringYes—Event type
github_deployment_refintegerYes—GitHub deployment ID
deployment_datadictYes—Deployment data
repository_uuiduuidNo—Repository UUID
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
event_typestringNo—Event type
github_deployment_refintegerNo—GitHub deployment ID
deployment_numberstringNo—Deployment node ID
environmentstringNo—Environment
refstringNo—Deployment ref
taskstringNo—Deployment task
descriptionstringNo—Deployment description
statusstringNo—Deployment status
creator_loginstringNo—Creator login
repository_uuiduuidNo—Repository UUID
synced_atstringNo—Synced 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-sync",
  "initial_data": {
    "action": "value",
    "event_type": "value",
    "github_deployment_ref": 123,
    "deployment_data": "value"
  }
}