Skip to content
Proud to collaborate with Microsoft for Startups

github.installation-sync-installation ​

Sync installation to DB based on sync_type

Sync GitHub App installation to database (create/update/delete/suspend/etc.)

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
sync_typestringYes—Sync type
github_installation_refintegerYes—GitHub installation ID
installation_datadictYes—Installation payload
organization_uuidstringNo—Organization UUID (public)
payloaddictNo—Full webhook payload
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
sync_typestringNo—Sync type
github_installation_refintegerNo—GitHub installation ID
installation_datadictNo—Installation payload
organization_uuidstringNo—Organization UUID (public)
payloaddictNo—Full webhook payload
skip_repo_syncbooleanNo——
deleted_installation_uuiduuidNo——
installation_uuiduuidNo——
trigger_full_syncbooleanNo——
cloud_connection_uuiduuidNo——
repos_actionstringNo——
actionstringNo——
installation_synced_atstringNo——
failure_reasonstringNo——
workflow_run_idstringNo—Parent DAG run ID
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—run—
runNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingrunrun—
runcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "github.installation-sync-installation",
  "initial_data": {
    "sync_type": "value",
    "github_installation_ref": 123,
    "installation_data": "value"
  }
}