CircleCI | Herald Docs
CircleCI
CircleCI
Connect CircleCI to give Herald’s SRE agent access to your CI pipeline data. The integration is scoped to a single CircleCI project slug you configure. During incident investigations, the agent can inspect pipelines, workflows, jobs, artifacts, and test metadata via the CircleCI API.
The agent can:
- List recent pipelines (optionally filtered by branch) and fetch pipeline details by ID or pipeline number
- List workflows for a pipeline and fetch workflow details
- List jobs for a workflow and fetch job details
- List job artifacts and test results for a job
| Parameter | Description |
|---|---|
| API Token | A CircleCI personal API token. Create one under User Settings > Personal API Tokens or from your project’s settings in CircleCI. |
| Project slug | The slash-separated project identifier from CircleCI Project Settings (for example, gh/my-org/my-repo, or the circleci/org-id/project-id form for GitHub App projects). |
Optional parameters
| Parameter | Description |
|---|---|
| Rules / Instructions | Free-form instructions that guide the agent on how to use this integration. |