Integrate CircleCI with CTO.ai

The CTO.ai CircleCI Orb lets you integrate your existing CircleCI-based development workflows with the CTO.ai platform. However you choose to make CircleCI part of your development process, our Orb gives you granular control of the events collected by the CTO.ai platform and allows you to send Insights Events at the points in your existing workflows where it makes the most sense.

Before you begin, you may want to review our documentation on Insights Events to better understand the concepts implemented by our platform.

Getting an API Token

You need an API token to use this feature. Before you can generate your API token, you must contact support for a ClientID and ClientSecret. Store the credentials you receive from us somewhere safe.

Using the CTO.ai CLI, sign in to your existing CTO.ai user account by running the ops account:signin command (or ops account:signup if you don’t already have an account with us). After you have signed in, you can generate a new API token using the credentials you received from CTO.ai support:

ops generate:token

When prompted by the CLI, enter your ClientID, ClientSecret, and CTO.ai account password. Your new token will then be generated.

Copy the newly-generated API token returned by the CLI and store it somewhere safe, as anyone with this token can use it to access the CTO.ai API on your behalf.

Using the CTO.ai CircleCI Orb

Our CircleCI Orb can be imported by specifying it under the orb key of your CircleCI configuration file, as shown here:

orbs:
  cto-ai: cto-ai/[email protected]

Use the Orb to send Events to the CTO.ai platform by calling it from the steps of a job in your CircleCI configuration:

version: 2.1
description: >
  Example showing how to send a workflow metric event to CTO.ai.
  Set CTOAI_EVENTS_API_TOKEN and CTOAI_EVENTS_API_TEAM_ID env vars
  in CircleCI settings.  

orbs:
  cto-ai: cto-ai/[email protected]

jobs:
   events_example_job:
      docker:
        - image: cimg/base:stable
      steps:
        - cto-ai/event:
            token: ${CTOAI_EVENTS_API_TOKEN}
            team_id: ${CTOAI_TEAM_ID}
            event_name: deployment
            event_action: succeeded
            branch: ticket-id-1234
            commit: pipeline-label-A1
            image: branch-label-543

workflows:
   events_example_workflow:
      jobs:
         - events_example_job

More information about using this Orb can be found in our CTO.ai Events Orb Example repository on GitHub.