Skip to main content
POST
Trigger pipeline run

Requirements

To run the API, the target pipeline must run on a Prophecy fabric. The pipeline does not need to be deployed.

Choose what to run

Choose what to run by adding one of these fields to the request:
If version does not match a release exactly, Prophecy runs the current working state instead and still reports success. Copy the version from the list releases query.
success in the response means the run was accepted, not that it finished. Check progress with the get pipeline run status API, and stop a run with the cancel pipeline run API.

Parameters

parameters works the same way for all three run types. Each key must be one of the pipeline’s own parameters; otherwise, the request returns Invalid config override. Project-level parameters cannot be overridden here. Set them per fabric when you deploy the project. A parameter of type SQL expression needs its own single quotes around text. Inside a single-quoted shell command, write each quote as '\'':

Headers

X-AUTH-TOKEN
string
required

Prophecy access token

Body

application/json

Pipeline run trigger parameters

fabricId
integer<int64>
required

Unique identifier of the fabric to run the pipeline on. Send it as a number, without quotes.

pipelineName
string
required

Name of the pipeline to be triggered.

projectId
string
required

Unique ID of the project where the pipeline resides. You can find this string in the URL of the project editor or metadata page.

parameters
object

Map of key-value pairs representing pipeline parameters. These override default parameter values for this run. Each key must be one of the pipeline's own parameters. Project-level parameters cannot be overridden here; set them per fabric when you deploy the project.

A parameter of type SQL expression needs its own single quotes around text values, for example "'2026-01-01'".

branch
string

Specific branch of the project to run, for example main. If omitted, the run uses the current working state of the project.

version
string

Published release of the project to run. Use the version exactly as the list releases query returns it. If the value does not match a release exactly, Prophecy runs the current working state instead and still reports success.

processName
string

Name of a specific gem within the pipeline. If provided, the pipeline will not run beyond this gem. If no processName is specified, the full pipeline is executed.

Response

200 - application/json

Pipeline run triggered successfully

success
boolean

Indicates whether the request to trigger the pipeline was successful. It does not reflect the success of the pipeline run.

runId
string

Unique identifier of the pipeline run.

msg
string

Error message if the request to trigger the pipeline was unsuccessful.