Execute PipelineAdmin Scope
Note: Ensure you have installed the required package to use this SDK method.
You can initiate a Catalyst pipeline run by passing the pipeline ID and the branch name to the runPipeline() SDK method. You can also pass environment variables required for the pipeline execution in a JSON object to this method, and it is completely optional. This method returns the execution history details of the pipeline as the response.
The pipelines reference used in the code snippets below is the component instance created to perform these operations.
copy
// run the pipeline
const execution_details = pipelines.runPipeline("PIPELINE_ID", 'BRANCH_NAME',{"EVENT": "push", "URL":"https://www.google.com"}); // replace the params with your pipeline id, branch, event and urlExample of Expected Reponse
copy
{
"history_id": "5000000021007",
"pipeline_id": "8431000000162051",
"event_time": "Mar 20, 2024 02:02 PM",
"event_details": {
"BRANCH_NAME": "main",
"EVENT": "push",
"URL": "https://www.google.com"
},
"history_status": "Queued"
}Last Updated 2026-07-02 14:51:41 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit