Skip to content
GitmoapAPIBeta
Schema

PipelineTrigger

One trigger condition a pipeline declares.

Shape

  • idPipelineTriggerId (string · uuid)
  • kindTriggerKindpushmerge_requesttagschedulemanualWhat caused a run to start.
  • ordinalinteger · int320–∞The trigger's position in the pipeline's list of triggers, counting from zero.
  • repository_idRepositoryId (string · uuid)
  • actionsarray of MrAction: one of opened | synchronized | reopened | mergedoptionalWhich merge-request events the trigger responds to. Empty for other kinds of trigger.
  • allow_pipeline_triggeredbooleanoptional
  • buildMrBuildTargetmerge_resultsourceor nulloptionalWhich commit a merge-request trigger builds: merge_result (the default — the commit merging would produce) or source (the source branch's own tip).
  • cronstring or nulloptional
  • pathsarray of stringoptional
  • patternstring or nulloptionalThe branch or tag pattern. Absent means every ref of its kind.
  • pipeline_idPipelineId (string · uuid) or nulloptional
  • ref_namestring or nulloptionalFor a pipeline defined in a file, the ref the trigger was read from. Absent for a pipeline defined through the API, whose triggers apply to every ref of their kind.
  • source_shastring or nulloptionalThe commit a file-authored projection was read at, so a client can say as declared at `a1b2c3` rather than implying the answer is universal.
  • stemstring or nulloptionalFor a pipeline defined in a file, the file's path (.gitmoap/pipelines/…) without its extension. Absent for a pipeline defined through the API.

Example

Synthesized example
{
"id": "4850b957-fc34-47f7-a4fc-de2205571a90",
"kind": "push",
"ordinal": 13,
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"actions": [
"opened",
"opened"
],
"allow_pipeline_triggered": false,
"build": "merge_result",
"cron": "cron-7773",
"paths": [
"paths-2a51"
],
"pattern": "pattern-c8bb",
"pipeline_id": "52d4ac5a-cf8b-4b32-8ed5-8c99db4839a1",
"ref_name": "payments-api",
"source_sha": "6b07a1a0af22487d94a7ff56bcd57d2cd1a8c457",
"stem": "stem-0801"
}

Graph

Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.