CircleCI
Developer tools Personal API tokenTrigger and inspect pipelines, workflows and jobs on CircleCI from any Windmill script, flow or app.
Set up in 3 steps
Create a personal API token
In CircleCI, open User Settings then Personal API Tokens, and create one. Copy it — it is shown only once.
Add the resource in Windmill
Open Resources, add a resource of type circleci, and paste the token.
Run your first script
Fork any script below and read before writing anything. There are dozens here, so search by the verb you need.
Scripts
Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.
User Information
Update an outbound webhook
Update a schedule
[Recommended] Trigger a new pipeline
Trigger a new pipeline
Set the decision settings
Retrieves the owner's decision audit logs.
Retrieves the owner's decision audit log by given decisionID
Retrieves a policy document
Retrieves Policy Bundle for a given decision log ID
Retrieves Policy Bundle
Rerun a workflow
Remove an environment variable
Patch project-level claims
Patch org-level claims
Makes a decision
List webhooks
List environment variables
List contexts
List all environment variables
Job timeseries data
Get your pipelines
Get the decision settings
Get test metrics for a project's workflows
Get test metadata
Get summary metrics with trends for the entire org, and for each project.
Get summary metrics for a project workflow's jobs.
Get summary metrics for a project's workflows
Get summary metrics and trends for a project across it's workflows and branches
Get recent runs of a workflow
Resource type
circleci — the shape of the credential every script on this page expects.
| Field | Type | Required | What it is |
|---|---|---|---|
| token | string | Yes |
Questions
How do I name a project?
As a project slug — the VCS, organization and repository joined by slashes, such as gh/acme/backend. Most calls take it rather than an id.
What can the token do?
Everything your own account can, on every project you can see. CircleCI personal tokens are not scoped per project.
Is my token stored on the hub?
Never. It lives only in your own Windmill workspace, encrypted at rest.