Skip to content
Proud to collaborate with Microsoft for Startups

github.pull_request-sync ​

Sync PR event for audit

Sync PR event (log for audit)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actionstringYes—PR action
github_pr_refintegerYes—GitHub PR ID
pr_datadictYes—PR data
repository_uuiduuidNo—Repository UUID
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
action_typestringNo—Action type
github_pr_refintegerNo—GitHub PR ID
pr_numberintegerNo—PR number
pr_titlestringNo—PR title
pr_statestringNo—PR state
is_draftbooleanNo—Is draft
mergedbooleanNo—Merged
merge_commit_shastringNo—Merge commit SHA
head_branchstringNo—Head branch
base_branchstringNo—Base branch
author_loginstringNo—Author login
reviewerslistNo—Requested reviewers
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.pull_request-sync",
  "initial_data": {
    "action": "value",
    "github_pr_ref": 123,
    "pr_data": "value"
  }
}