Trigger pipeline run
Start one run of one pipeline on one fabric and return its run ID. The pipeline does not need to be deployed. By default, the run uses the project as it is now in Prophecy, including saved changes that are not committed yet. Use branch or version to run a specific branch or published release instead.
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: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
Prophecy access token
Body
Pipeline run trigger parameters
Unique identifier of the fabric to run the pipeline on. Send it as a number, without quotes.
Name of the pipeline to be triggered.
Unique ID of the project where the pipeline resides. You can find this string in the URL of the project editor or metadata page.
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'".
Specific branch of the project to run, for example main. If omitted, the run uses the current working state of the project.
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.
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
Pipeline run triggered successfully

