Skip to content
Proud to collaborate with Microsoft for Startups

gitops.dispatch-on-event ​

Fan a GitHub push/release event out to matching gitops.sync reconciles

Find the GitOpsApplications a git event should sync and start a reconcile for each. Intended to be invoked as a step in the github.push / github.release DAGs.

Inputs:

  • organization_uuid: org the webhook resolved to (required).
  • github_repository_uuid: GitHubRepository UUID from the webhook DAG (required).
  • branch: pushed branch name (push events).
  • is_release: True for release/tag events.

Composes data.gitops.application.list-for-repo, then starts gitops.sync per match (async, trigger=webhook).

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-gitops
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
github_repository_uuiduuidYes——
branchstringNo——
is_releasebooleanNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
dispatchedintegerNo——
application_uuidsjsonNo——
sync_workflow_idsjsonNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—dispatch—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingdispatchcompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "gitops.dispatch-on-event",
  "initial_data": {
    "organization_uuid": "value",
    "github_repository_uuid": "value"
  }
}