CodeSignal offers APIs that can be leveraged in different ways to to automate your workflows. There are two different APIs available, each suitable for different applications and needs. Let's look into both of these APIs in more detail.

CodeSignal GraphQL API

The CodeSignal GraphQL API is a powerful tool that can be used to automate many actions that you might perform manually on CodeSignal or to query data from your organization's CodeSignal instance.

To get started using the GraphQL API, you'll need to set up an API key. If you're not able to access this option, please ensure that you have the proper permissions:

If you do not have these permissions you will not be able to edit these settings. A CodeSignal admin from your organization can help you with this if needed, so please reach out to the appropriate contact within your organization to get these set up.

If you are sure you have the correct permissions but you are still unable to see the API key settings, please reach out to support@codesignal.com to get API support enabled for your organization's CodeSignal instance.

GraphQL API Documentation

Once you're ready to get started, you can review the full developer documentation for the CodeSignal GraphQL API here: https://developer.codesignal.com/graphql/

If you're just interested in the schema, you can view that directly here: https://developer.codesignal.com/graphql/types/index.html

CodeSignal Webhook API

The CodeSignal webhook API can be used to receive automatic notifications from CodeSignal when certain actions are triggered. You can then take the data received from these notifications to perform different kinds of custom automations.

To get started using CodeSignal webhooks, you'll need to configure your webhook settings. Similar to the GraphQL API above, please ensure that you have the proper permissions if you're not able to access these settings:

If you do not have these permissions you will not be able to edit these settings. A CodeSignal admin from your organization can help you with this if needed, so please reach out to the appropriate contact within your organization to get these set up.

If you are sure you have the correct permissions but you are still unable to see the API key settings, please reach out to support@codesignal.com to get API support enabled for your organization's CodeSignal instance.

Webhook API Documentation

Once you're ready to get started, you can review the full developer documentation for the CodeSignal webhook API here: https://developer.codesignal.com/webhooks/

Still have questions?

Please email support@codesignal.com for any other questions you may have about our APIs and how to use them.