Skip to content
Proud to collaborate with Microsoft for Startups

github.pull_request-complete ​

Complete pull_request workflow

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
github_pr_refintegerYes—GitHub PR ID
pr_numberintegerYes—PR number
pr_titlestringYes—PR title
action_typestringYes—Action type
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
github_pr_refintegerNo—GitHub PR ID
pr_numberintegerNo—PR number
pr_titlestringNo—PR title
action_typestringNo—Action type
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.pull_request-complete",
  "initial_data": {
    "github_pr_ref": 123,
    "pr_number": 123,
    "pr_title": "value",
    "action_type": "value"
  }
}