Linking CircleCI as a source

Alpha release

This source is currently in alpha. The interface and available tables may change.

The CircleCI connector syncs your CI/CD pipeline data – pipelines, workflows, jobs, and projects – into PostHog.

Adding a data source

Go to the sources tab of the data pipeline section in PostHog.
Click + New source and then click Link next to CircleCI.
Next, you need a personal API token from CircleCI. In your CircleCI user settings, create a new personal API token and copy it. The token inherits your user permissions and grants read access to your organization's data.
You also need your organization slug in the vcs/org format. For example, if your organization is on GitHub with the name your-org, the slug is gh/your-org. For Bitbucket, use bb/your-org. You can find it under Organization settings in CircleCI.
Back in PostHog, enter the personal API token and organization slug, then click Next.
Select the tables you want to sync, set the sync frequency, then click Import.

Once the syncs are complete, you can start using CircleCI data in PostHog.

Table	Description	Sync method
`pipelines`	CI/CD pipelines in your organization	Full refresh
`workflows`	Workflows within pipelines	Full refresh
`jobs`	Individual jobs within workflows	Full refresh
`projects`	Projects associated with your pipelines	Full refresh

Full refresh tables reload all data on each sync. CircleCI's API does not support incremental syncing.

Option	Description
`Personal API token` Type: password Required: True
`Organization slug` Type: text Required: True	The organization slug in `vcs/org` format, e.g. `gh/your-org`. You can find it under Organization settings in CircleCI.