Skip to main content
POST
/
api
/
trigger
/
pipeline
Trigger pipeline run
curl --request POST \
  --url https://app.prophecy.io/api/trigger/pipeline \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "fabricId": 33290,
  "pipelineName": "bakehouse",
  "parameters": {
    "franchise_id": "3000007"
  },
  "version": "2",
  "projectId": "41459",
  "processName": "franchise_reviews"
}
'
{
  "success": false,
  "msg": "error in triggering pipeline: Success(Left(sdl.md.client.package$MetadataException: Fabric with uid `2290` not found)) (of class scala.util.Success)"
}

​
Requirements

To run the API, the target pipeline must: In other words, the pipeline must be deployed.

Headers

​
X-AUTH-TOKEN
string
required

Prophecy access token

Body

application/json

Pipeline run trigger parameters

​
fabricId
integer<int64>
required

Unique identifier of the data fabric where the pipeline resides. You can find the ID in the URL of the fabric metadata page.

​
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 will override default parameter values.

​
branch
string

Specific branch of the pipeline to execute. If omitted, the current working branch is used.

​
version
string

Specific version of the project containing the pipeline. If omitted, the latest version is used.

​
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.