Circle CI

Circle CI

Circle CI integration - Connect and automate your Circle CI workflows

Visit Website

Triggers & Actions

Use Circle CI as a trigger to kick off a workflow, or use it as an action to do something automatically in your workflow.

Triggers

  • CircleCI Webhook Trigger

    Triggers when CircleCI events occur (workflow completed, job completed, etc.). Real-time webhook notifications.

Actions

  • Collaborations

    Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the current users account

  • User Information

    Provides information about the user that is currently signed in.

  • List Webhooks

    Get a list of outbound webhooks that match the given scope-type and scope-id

  • Delete ASchedule

    Not yet available to projects that use GitLab or GitHub App. Deletes the schedule by id.

  • Get ASchedule

    Get a schedule by id.

  • Create ASchedule

    Not yet available to projects that use GitLab or GitHub App. Creates a schedule and returns the created schedule.

  • Get All Schedules

    Returns all schedules for this project.

  • Cancel Job By Job Number

    Cancel job with a given job number.

  • Cancel Job By Job ID

    Cancel job with a given job ID.

  • Get Job Details

    Returns job details.

  • Approve AJob

    Approves a pending approval job in a workflow.

  • Rerun AWorkflow

    Reruns a workflow.

  • Cancel AWorkflow

    Cancels a running workflow.

  • Get AWorkflow

    Returns summary fields of a workflow by ID.

  • Get All Pipelines

    Returns all pipelines for this project.

  • Get APipeline By ID

    Returns a pipeline by the pipeline ID.

  • Continue APipeline

    Continue a pipeline from the setup phase. For information on using pipeline parameters with dynamic configuration, see the [Pipeline values and parameters](https://circleci.com/docs/pipeline-variables/#pipeline-parameters-and-dynamic-configuration) docs.

  • Get AList Of Pipelines

    Returns all pipelines for the most recently built projects (max 250) you follow in an organization.

  • Trigger a New Pipeline

    **[This endpoint is superseded by the [new Trigger Pipeline API](#tag/Pipeline/operation/triggerPipelineRun), which supports all organization and pipeline types except GitLab.]** Triggers a new pipeline on the project. Does not support triggering pipelines integrated with GitLab or GitHub App.

  • Delete An Environment Variable

    Deletes the environment variable named :name.

  • Get AMasked Environment Variable

    Returns the masked value of environment variable :name.

  • Create An Environment Variable

    Creates a new environment variable.

  • List All Environment Variables

    Returns four x characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.

  • Delete ACheckout Key

    Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded.

  • Create ANew Checkout Key

    Not available to projects that use GitLab or GitHub App. Creates a new checkout key. This API request is only usable with a user API token. Please ensure that you have authorized your account with GitHub before creating user keys. This is necessary to give CircleCI the permission to create a user key associated with your GitHub user account. You can find this page by visiting Project Settings > Checkout SSH Keys

  • Get All Checkout Keys

    Returns a sequence of checkout keys for `:project`.

  • Delete AProject

    Deletes a project by project slug

  • Get AProject

    Retrieves a project by project slug.

  • Remove An Environment Variable

    Delete an environment variable from a context.

  • List Environment Variables

    List information about environment variables in a context, not including their values.

  • Delete AContext

    Delete a context by its ID. Will also delete all environment variables inside the context.

  • Get AContext

    Returns basic information about a context.

  • List Contexts

    List all contexts for an owner.