CircleCI Integration

This guide is for you to set up the FOSSA app in your CI workflow. We offer two ways currently for you to integrate FOSSA into your workflow, through a CircleCI Build Step, or a Post-build Webhook.

CircleCI Build Step

We have provided a script that you may run as a custom build step that checks for the build and issues scan status of the FOSSA project. This is available Here.

In order for this to work, you will also have generate a FOSSA API token. This can be found in Integration Settings:

API Token

Once this is generated, you will have to add this as an environment variable named FOSSA_API_TOKEN in your CircleCI build. After that, you are all set up!

Post-build Webhook

Another way to integrate FOSSA into your workflow is to set up a webhook notification in CircleCI. To do this, you will have to add the following to your circle.yml file:

    - url:

You will also have to update your project settings in FOSSA by navigating to Project > Settings > Update Hooks, and selecting CircleCI in the dropdown.