How to integrate CircleCI with Sapho version 3.9 or greater

Last update:

Important Notes

1. In order to distinguish Sapho activity from an individual user's activity, we recommend creating a dedicated CircleCI account (for example, sapho@company.com) and then using it to set up the CircleCI connector in Sapho. This dedicated user account must have a role with full privileges to trigger new builds.

2. If your internal server hosting Sapho is behind a firewall, you will need to allow access to hostname www.circleci.com with port 443, so Sapho can connect to the CircleCI cloud.

Step 1: Sign in

Log in to https://circleci.com/ with the dedicated user account.

Step 2: Go to Account Settings

Click the Account Settings on the left sidebar and choose Personal API Token. Click the Create New Token button. Enter new token name and click the Add API Token button to confirm.

CircleCI.png

Step 3: Use Token

Copy the generated token and use it within the connector configuration form in Sapho.

Audit Trail

When a user triggers a new build with a branch via Sapho app, a custom build parameter sapho_triggered_by is send for custom user identification. This may be particularly useful for audit logs.