Triggers

How do Pipelines start?

Every pipeline must have at least one trigger. A trigger is a persistent object used to determine how a pipeline should start.

There are four options:

  • Manual

  • Webhook

  • Cron

  • Pipeline

While the UI will only allow you to select a single trigger, by default, both Manual and Webhook are enabled. Therefore, a pipeline may have up to three triggers.

Manual

A manual trigger means the pipeline will only run if the user runs it via the UI.

Webhook

The pipeline is triggered via a HTTP webhook. To configure this, the UI will show the POST endpoint you need to invoke for the pipeline. A bearer token for authorisation is also provided, and this is compulsory to trigger the pipeline.

The Bearer token can be found under Settings -> Api key

The endpoint to trigger the pipeline is takes the following form:

https://app.getorchestra.io/engine/public/pipelines/{pipeline-id}/start

The pipeline ID can be found in the URL of a selected pipeline.

Cron

If a pipeline has a cron schedule then the pipeline will run when the schedule specifies it to run.

Pipeline

A successful run of another pipeline can trigger subsequent pipelines to run. Each pipeline can be triggered by only one pipeline, but a pipeline itself can trigger as many pipelines as required. We check to make sure circular dependencies will not be introduced.

Last updated