CircleCI

At a glance

Availability: Experimental (how to enable).
Auth: API key.
Connection: The key from CIRCLECI_TOKEN is sent as the Circle-Token header.
Docs: https://circleci.com/docs/api/v2/index.html

Set these per environment. See Connect an integration.

Variable	Required	Description
`CIRCLECI_TOKEN`	Yes	CircleCI personal API token (User Settings > Personal API Tokens) Docs.

Sign in to CircleCI: Go to https://app.circleci.com and sign in (the free plan with a connected GitHub repo is sufficient for testing).
Create a personal API token: Open User Settings > Personal API Tokens (https://app.circleci.com/settings/user/tokens) and create a token.
Set the environment variable: Add the token to your .env as CIRCLECI_TOKEN=…
Find your project slug: Slugs look like gh/your-org/your-repo (or circleci/<org-id>/<project-id> for GitLab and GitHub App projects). Run List Pipelines with it to verify access.

CircleCI authenticates with a ‘Circle-Token’ header
Project slugs contain slashes (vcs/org/repo) and are passed verbatim in the URL path
Personal tokens act with your user’s permissions across all your organizations

Tool	Access	Description
List Pipelines	Read	List recent pipelines for a project
Get Pipeline	Read	Get a pipeline by its ID
Trigger Pipeline	Write	Trigger a new pipeline for a project on a branch or tag
List Pipeline Workflows	Read	List the workflows of a pipeline
Get Workflow	Read	Get a workflow by its ID
List Workflow Jobs	Read	List the jobs of a workflow with their statuses
Cancel Workflow	Write	Cancel a running workflow

Show the most recent CircleCI pipelines for my project and the status of their workflows.
Find the last failed CircleCI workflow for my project and list which jobs failed.