Skip to main content

CircleCI

Overview​

The CircleCI source connector connects to the CircleCI API using a personal API token.

At this time, the connector supports credential validation but data extraction is still in development. You can use it to verify connectivity/authentication, but it will not yet sync any streams.

Setup​

Prerequisites​

  • A CircleCI account with access to the organizations/projects you intend to sync.
  • A CircleCI API token.

Create a CircleCI API token​

  1. In CircleCI, go to User Settings.
  2. Navigate to Personal API Tokens.
  3. Create a new token and copy it.

Authentication​

CircleCI authentication is performed by sending your token in the Circle-Token header.

The connector validates credentials by calling:

  • GET https://circleci.com/api/v2/me

Configuration​

FieldTypeRequiredDescription
api_tokenstring✅Your CircleCI personal API token.

Streams​

No streams are currently available. The connector’s extraction/sync functionality is still in development.

Limitations​

  • No catalog/streams yet: The connector currently returns an empty catalog.
  • No extraction yet: Sync attempts will fail with a message indicating extraction is still in development.