Overview
CircleCI is a hosted CI/CD platform. The Automize CircleCI connector covers pipeline triggering, status reads, projects, workflows, jobs, and contexts (shared env vars).
- Regions: CircleCI Cloud is global (circleci.com). Server (self-hosted) versions use a different base URL.
- Plans: Free, Performance, Scale – all expose the v2 REST API.
Setting up the connection
Auth type: Bearer Token.
- Sign in to CircleCI → User Settings → Personal API Tokens → Create New Token.
- Copy the token.
- In Automize, open Settings → Connectors → CircleCI → Add connection. Paste token.
Find your credentials at https://app.circleci.com/settings/user/tokens.
Rate limits
CircleCI enforces per-user limits. Pipeline triggers don't have hard caps beyond your plan's CI minute budget.
Data model
Project-centric:
Project (Github/GitLab/Bitbucket repo) ─┬─ Pipelines (per-commit-or-trigger)
│ └─ Workflows (parallel or sequential)
│ └─ Jobs (actual builds/tests)
└─ Contexts (named env-var bundles, shared across projects)
project_slug format: vcs-type/org/repo (e.g. gh/myorg/myrepo).Available operations
8 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Get Pipeline | General | Get pipeline details |
| Get Project | General | Get project details |
| Get Workflow | General | Get workflow details |
| List Contexts | General | List contexts for an organization |
| List Jobs | General | List jobs in a workflow |
| List Pipelines | General | List recent pipelines for a project |
| List Workflows | General | List workflows for a pipeline |
| Trigger Pipeline | General | Trigger a new pipeline |
Operations
Get Pipeline
Get pipeline details
| Parameter | Required | Type | Description |
|---|---|---|---|
Pipeline Id pipeline_id | Yes | text |
Tips
- Returns pipeline + status (created, running, success, failed, errored, canceled).
Get Project
Get project details
| Parameter | Required | Type | Description |
|---|---|---|---|
Project Slug project_slug | Yes | text |
Tips
- Returns project settings + recent build counts.
Get Workflow
Get workflow details
| Parameter | Required | Type | Description |
|---|---|---|---|
Workflow Id workflow_id | Yes | text |
Tips
- Returns status + per-job status.
List Contexts
List contexts for an organization
No input parameters.
Tips
- Contexts hold shared env vars. Returns context IDs + names.
List Jobs
List jobs in a workflow
| Parameter | Required | Type | Description |
|---|---|---|---|
Workflow Id workflow_id | Yes | text |
Tips
- Jobs in a workflow. Returns name, status, started_at, stopped_at.
List Pipelines
List recent pipelines for a project
| Parameter | Required | Type | Description |
|---|---|---|---|
Project Slug project_slug | Yes | text |
Tips
- project_slug: gh/myorg/myrepo. Returns recent pipelines.
- Filter by branch.
List Workflows
List workflows for a pipeline
| Parameter | Required | Type | Description |
|---|---|---|---|
Pipeline Id pipeline_id | Yes | text |
Tips
- Workflows in a pipeline. Each pipeline can have 1+ workflows defined in .circleci/config.yml.
Trigger Pipeline
Trigger a new pipeline
| Parameter | Required | Type | Description |
|---|---|---|---|
Project Slug project_slug | Yes | text | |
Branch branch | Yes | text | |
Tag tag | Yes | text | |
Parameters parameters | Yes | text |
Tips
- project_slug + branch (or tag) + optional parameters dict.
- Returns pipeline_id – use to track status.
FAQ
- How do I cancel a running pipeline?
- Cancel Workflow (not exposed here) – cancel by workflow_id, which cancels all its in-flight jobs. Or cancel from CircleCI UI.
- Why does Trigger Pipeline return 404?
- Check project_slug format: vcs-type/org/repo. Common typo – using gh/ vs github/. Use gh/, bb/, or gitlab/.
- Parameters – when?
- Pass parameters: {deploy: 'production', region: 'us-east-1'} on Trigger Pipeline. Reference in .circleci/config.yml via parameters: section.