> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CircleCI

> How to set up the CircleCI connector, plus the actions and events that are available.

![CircleCI](https://stackone-logos.com/api/circleci/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/circleci/changelog.md)

[82 actions](#actions) · [2 events](#events) · 1 auth method

Developer Tools

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal API Token · Connector Profile](https://docs.stackone.com/connectors/circleci/guides/connector-profile/personal-api-token.md)
>
> Connect your CircleCI account using a Personal API Token generated from the CircleCI web application.

Optionally, configure receiving Events for CircleCI into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/circleci/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal API Token · Link Account](https://docs.stackone.com/connectors/circleci/guides/link-account/personal-api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

82 actions

ActionDescription

Get Current User`circleci_get_current_user_information`

Get current authenticated user info

Get User`circleci_get_user_information`

Get a user by ID

List Collaborations`circleci_list_collaborations`

List organizations the current user is a member of, including their org IDs and slugs. ALWAYS call this first before any...

List Pipelines`circleci_list_pipelines`

Get a list of pipelines across ALL recently built projects in an organization (org-wide view, up to 250 projects). If yo...

List Project Pipelines`circleci_list_project_pipelines`

Get all pipelines for a SPECIFIC project by its project-slug. Use this instead of list\_pipelines when you want pipelines...

Trigger Pipeline`circleci_trigger_pipeline`

Trigger a new pipeline for a project

Get Pipeline`circleci_get_pipeline`

Get a pipeline by ID

Get Pipeline Configuration`circleci_get_pipeline_configuration`

Get the configuration for a pipeline

Get Pipeline Workflows`circleci_get_pipeline_workflows`

Get all workflows for a pipeline

Trigger Pipeline Run`circleci_trigger_pipeline_run`

Trigger a new pipeline run from a pipeline definition

Get Pipeline By Number`circleci_get_pipeline_by_number`

Get a pipeline by its pipeline number for a given project. Get the project-slug from the project\_slug field in list\_pipe...

Get Pipeline Values`circleci_get_pipeline_values`

Get pipeline values for a pipeline

List My Pipelines`circleci_list_my_pipelines`

Get all pipelines triggered by the current user for a project

Continue Pipeline`circleci_continue_pipeline`

Continue a pipeline from the setup phase

List Contexts`circleci_list_contexts`

List all contexts for an owner (organization). Use owner-id (UUID) OR owner-slug (format "gh/org-name" for GitHub, "circ...

Create Context`circleci_create_context`

Create a new context

Get Context`circleci_get_context`

Get a context by ID

List Context Environment Variables`circleci_list_context_env_vars`

List environment variables in a context

Add Or Update Context Environment Variable`circleci_add_context_env_var`

Add or update an environment variable in a context

Delete Context Environment Variable`circleci_remove_context_env_var`

Remove an environment variable from a context

Delete Context`circleci_delete_context`

Delete a context

Create Context Restriction`circleci_create_context_restriction`

Create a project or expression restriction on a context to control which projects can use it. Returns 409 Conflict if th...

Get Context Restrictions`circleci_get_context_restrictions`

Get a list of restrictions associated with a context

Delete Context Restriction`circleci_delete_context_restriction`

Delete a restriction from a context

Get Organization`circleci_get_organization`

Get an organization by slug or ID

Create Organization`circleci_create_organization`

Create a new organization

List Orb Allow-List Entries`circleci_list_orb_allow_list`

List entries in an organization's URL Orb allow-list

Create Orb Allow-List Entry`circleci_create_orb_allow_list_entry`

Create a new URL Orb allow-list entry

Delete Organization`circleci_delete_organization`

Delete an organization

Delete Orb Allow-List Entry`circleci_delete_orb_allow_list_entry`

Remove an entry from the org's URL orb allow-list

List Webhooks`circleci_list_webhooks`

List outbound webhooks for a scope

Create Webhook`circleci_create_webhook`

Create an outbound webhook

Get Webhook`circleci_get_webhook`

Get a webhook by ID

Update Webhook`circleci_update_webhook`

Update an outbound webhook

Delete Webhook`circleci_delete_webhook`

Delete an outbound webhook

Get Project Workflow Runs`circleci_get_project_workflow_runs`

Get recent runs of a workflow

Get All Branches`circleci_get_all_insights_branches`

Get all branches for a project

Get Organization Summary Metrics`circleci_get_org_summary`

Get aggregated summary metrics for an organization, including success rates, duration, and throughput across all project...

Get Project Workflow Metrics`circleci_get_project_workflow_metrics`

Get summary metrics for a project's workflows

Get Flaky Tests`circleci_get_flaky_tests`

Get flaky tests for a project

Get Project Workflow Summary`circleci_get_project_workflow_summary`

Get summary metrics and trends for a project across its workflows and branches

Get Job Timeseries Data`circleci_get_job_timeseries`

Get timeseries data for all jobs within a workflow

Create Project`circleci_create_project`

Create a new project

Get Project`circleci_get_project`

Get a project by its project-slug (format "vcs-slug/org-name/repo-name"). Returns 404 if the project does not exist. IMP...

Get Project Settings`circleci_get_project_settings`

Get advanced settings for a project. The provider/organization/project path params are the three segments of the project...

Update Project Settings`circleci_update_project_settings`

Update advanced settings for a project. The provider/organization/project path params are the three segments of the proj...

List Checkout Keys`circleci_list_checkout_keys`

Get all checkout keys for a project

Create Checkout Key`circleci_create_checkout_key`

Create a new checkout key for a project

List Project Environment Variables`circleci_list_project_env_vars`

List all environment variables for a project

Create Project Environment Variable`circleci_create_project_env_var`

Create an environment variable for a project

Get Project Environment Variable`circleci_get_project_env_var`

Get a masked environment variable by name

Delete Project Environment Variable`circleci_delete_project_env_var`

Delete an environment variable from a project

Get Workflow`circleci_get_workflow`

Get a workflow by ID

Get Workflow Jobs`circleci_get_workflow_jobs`

Get all jobs for a workflow

Approve Job`circleci_approve_job`

Approve a pending approval job in a workflow

Cancel Workflow`circleci_cancel_workflow`

Cancel a running workflow

Rerun Workflow`circleci_rerun_workflow`

Rerun a workflow

Get Job Details`circleci_get_job_by_number`

Get job details by job number

Cancel Job`circleci_cancel_job_by_number`

Cancel a job by job number

Cancel Job By ID`circleci_cancel_job_by_id`

Cancel a job by its unique ID

Get Job Artifacts`circleci_get_job_artifacts`

Get artifacts for a job

Get Job Test Metadata`circleci_get_job_test_metadata`

Get test metadata for a job

Get Job`circleci_get_job`

Get a job by ID

List Schedules`circleci_list_schedule_triggers`

List schedule triggers for a project

Create Schedule`circleci_create_schedule`

Create a pipeline schedule for a project

Get Schedule`circleci_get_schedule`

Get a schedule by ID

Update Schedule`circleci_update_schedule`

Update a pipeline schedule

Delete Schedule`circleci_delete_schedule`

Delete a schedule

List Pipeline Definitions`circleci_list_pipeline_definitions`

List all pipeline definitions for a project

Get Pipeline Definition`circleci_get_pipeline_definition`

Get details for a pipeline definition

Create Pipeline Definition`circleci_create_pipeline_definition`

Create a pipeline definition for a project. The config\_source.provider must match the project's actual integration type...

Update Pipeline Definition`circleci_update_pipeline_definition`

Update an existing pipeline definition's name, config file path, or checkout source. You cannot change the provider type...

Delete Pipeline Definition`circleci_delete_pipeline_definition`

Delete a pipeline definition

List Environments`circleci_list_environments`

List environments for an organization

Get Environment`circleci_get_environment`

Get an environment by ID

List Components`circleci_list_components`

List components for an organization

Get Component`circleci_get_component`

Get a component by ID

List Component Versions`circleci_list_component_versions`

List versions for a component

List Groups`circleci_list_groups`

Get all groups in an organization

Create Group`circleci_create_group`

Create a new group in an organization

Get Group`circleci_get_group`

Get details for a group in an organization

Delete Group`circleci_delete_group`

Delete a group in an organization

## Events

Tags

Select all
|
Clear

Jobs

Webhooks

Workflows

No tags found

2 events

EventDescriptionTags

Workflow Completed`circleci_webhook_workflow_completed`

Processes events fired when a CircleCI workflow finishes, carrying the workflow outcome plus the pipeline, project and o...

WorkflowsWebhooks

Job Completed`circleci_webhook_job_completed`

Processes events fired when a CircleCI job finishes, carrying the job outcome plus the workflow, pipeline, project and o...

JobsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.