CircleCI Integration

Query CircleCI via Retool.

Integrate Retool and CircleCI

To connect your resource to CircleCI, add your personal API token which you can find here. You may need to create a new key if you don't have one already.

Note: Do not use a project API token as this does not work with the latest version of CircleCI's API. You can read more about CircleCI's API authentication and authorization here.

Save the resource and that's it! You can now query the CircleCI API in Retool!

Querying the CircleCI API

After setting up a CircleCI integration with Retool, a new option for a CircleCI query will appear on the Retool page editors. After selecting that option, you will be presented with a UI that allows you to use any of the end points in the CircleCI api spec to send and retrieve data from CircleCI. You can learn about other popular use cases around drill downs into project details, reviewing artifacts and analyzing insights here.

Getting workflows

For many applications, like our CircleCI template, you'll want to pull in all the CircleCI workflows to drill down, approve and kickoff new jobs, and more. This JS snippet will be helpful for getting the data returned by the workflows endpoint and transforming it into a flattened array. You can then connect this to a table to immediately visualize and build CRUD interfaces on top of this workflow data.

const workflows = getAllWorkflows.data
return Promise.all(
  workflows.map(workflow => 
    getJobByWorkflow.trigger({additionalScope: {workflowId: workflow.id}}).then(data => data.map(obj => ({...obj, workflow_id: workflow.id})))
  )
).then(data => data.flat())

Updated about a month ago


CircleCI Integration


Query CircleCI via Retool.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.