Execute Pipeline

You can initiate a Catalyst pipeline run by passing the pipeline ID and the branch name as parameters to the runPipeline() 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_service reference used below is already defined in this component instance page.

    

        
copy
        

            

        
    
    

         let execution_details  = pipelines_service.runPipeline("8431000000162051", main,{"EVENT": "push", "URL":"https://www.google.com"})

    

A sample response is shown below:

    

        
copy
        

            

        
    
    

         {
 "status": "success",
 "data": {
 "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"
 }
}