Trigger Pipeline
circleci.trigger_pipeline
ActionBusiness appsconnection required
Calls the CircleCI API with the connection's credentials.
Trigger a pipeline for a project.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- CircleCI
- Secret shape
- the personal API token, or {"token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
project_slug e.g. gh/org/repo. | string | Yes | — | — | — |
branch Branch to build. | string | No | — | — | — |
parameters Pipeline parameters (JSON). | object | No | — | — | — |
Output
One shape.
result
The provider's response object, as returned.
Extra keys beyond the ones listed can appear.
{}Related CircleCI nodes
See Trigger Pipeline run in a workflow.
In a technical demo we add the CircleCI connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.