Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

CircleCI

Trigger pipelines and read workflow/job status via the CircleCI v2 REST API.

Authentication

Generate a personal API token at: https://app.circleci.com/settings/user/tokens

The tool sends it as the Circle-Token header — no Bearer prefix required.

Operations

Operation	Description	Required inputs
`trigger-pipeline`	Trigger a new pipeline run	`projectSlug`
`get-pipeline`	Fetch full details for a pipeline	`pipelineId`
`list-workflows`	List all workflows for a pipeline	`pipelineId`
`get-workflow`	Fetch status and metadata for a workflow	`workflowId`
`list-jobs`	List all jobs (with status/timing) in a workflow	`workflowId`

Project slug format

vcs-type/org-name/repo-name

Examples: - gh/acme/my-service — GitHub - bb/acme/my-service — Bitbucket - circleci/ORG_ID/PROJECT_ID — GitLab or GitHub App projects

Outputs

Key	Description
`result`	Raw JSON response body from CircleCI
`status`	HTTP status code (string)
`ok`	`"true"` if 2xx, `"false"` otherwise
`operation`	The operation that was executed

Examples

Trigger a pipeline on a branch:

apiKey:       <your-token>
operation:    trigger-pipeline
projectSlug:  gh/acme/my-service
branch:       main

Trigger with pipeline parameters:

apiKey:       <your-token>
operation:    trigger-pipeline
projectSlug:  gh/acme/my-service
branch:       staging
parameters:   {"deploy_env":"staging","run_smoke_tests":true}

Get pipeline details:

apiKey:      <your-token>
operation:   get-pipeline
pipelineId:  a1b2c3d4-e5f6-7890-abcd-ef1234567890

List workflows for a pipeline:

apiKey:      <your-token>
operation:   list-workflows
pipelineId:  a1b2c3d4-e5f6-7890-abcd-ef1234567890

Get workflow status:

apiKey:      <your-token>
operation:   get-workflow
workflowId:  f9e8d7c6-b5a4-3210-fedc-ba9876543210

List jobs in a workflow:

apiKey:      <your-token>
operation:   list-jobs
workflowId:  f9e8d7c6-b5a4-3210-fedc-ba9876543210

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
ok
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: trigger-pipeline, get-pipeline, list-workflows, get-workflow, list-jobs
`projectSlug`	string	no	—	Project slug in the form vcs-type/org-name/repo-name (e.g. gh/acme/my-service). Required for trigger-pipeline.
`branch`	string	no	—	Branch name to run the pipeline on. Used by trigger-pipeline; omit to trigger the project default.
`parameters`	string	no	—	JSON object string of pipeline parameters to pass when triggering, e.g. '{"deploy_env":"staging"}'. Optional for trigger-pipeline.
`pipelineId`	string	no	—	Pipeline UUID. Required for get-pipeline and list-workflows.
`workflowId`	string	no	—	Workflow UUID. Required for get-workflow and list-jobs.