promiseofcake/CircleCI Workflow API Trigger

GitHub Action to trigger CircleCI pipelines using the new API v2 endpoint.

View on GitHub

Trust Signals

Scorecard Score
Scorecard 4–6scored Jul 6, 2026
Maintenance Recency
Activelast commit Jul 9, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: promiseofcake/circleci-trigger-action@07e4e215d614a37e9561353b50becdb82e4fa2f5 # v3.0.3

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
project-slugGitHub repository name in format: org-name/repo-name (e.g., promiseofcake/circleci-trigger-action)yes${{ github.repository }}
user-tokenCircleCI User Token used to authorize the workflow runyes
branchBranch for the CircleCI contextual run.yes${{ github.head_ref }}
definition-idPipeline definition ID for the CircleCI pipeline to triggeryes
payloadPayload data (JSON) to send to the Workflow endpointyes{}

no outputs