In order to set up your CodeSignal integration, you will need to do three things:
The steps below will walk you through the process necessary to initiate your CodeSignal integration.
Step 1: Generate an API Key
Log in to CodeSignal and navigate to the Client Dashboard. Then, select your user icon in the top-right corner and click on Integrations.
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/downloads.intercomcdn.comio5268513870cf90e24d7d62e39474e8453image-2.png)
Select API Keys from the menu on the left-hand side.
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/downloads.intercomcdn.comio52685163288f3c1eb6c44d621bf181fc8image-2.png)
Then, click Add a Key and add 'RippleMatch Integration' in the description field.
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/downloads.intercomcdn.comio52685177433146e9bd48193e2971bdd18image-2.png)
Next, add all permissions to your key and click Save to see the following screen:
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/ripplematch.intercom-attachments-1.comio5268613576abb7202795e2ab0faa3883aimage8-2.png)
Then, copy the new API Key to share with your RippleMatch team.
Step 2: Generate a Webhook
Navigate to the Integrations section again. Then, click Add a Webhook.
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/ripplematch.intercom-attachments-1.comio526861362522e64698dfffd143f55074dimage5-2.png)
Next, select the following Event Types:
-
certificationResultPending
-
certificationResultShared
-
certificationResultNotCertified
-
certificationRequestExpired
-
certificationRequestExpired
-
certificationResultRejected
Then, add the following endpoint:
Next, select the option to Add a Header and fill in the fields as follows:
-
Field #1: User-Agent
-
Field #2: Codesignal-<company_name>
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/ripplematch.intercom-attachments-1.comio5268613781875938525bb9a1373e4067bimage1-2.png)
Then, click the Test button next to the Endpoint field.
If the test is successful, you will see the following message:
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/downloads.intercomcdn.comio5268594323e60749c72e8bd4151174efaimage-2.png)
Next, click Create.
Step 3: Provide the Public-ID
After generating the API Key and Webhook, head to the role(s) in RippleMatch that you'd like to automate the CodeSignal assessment for, and copy and paste the Public-ID from the address bar.
![](https://resources.ripplematch.com/hubfs/Knowledge%20Base%20Import/ripplematch.intercom-attachments-7.comio55288609102d4fc51ee265f3665cde57aw0_dRf-8usO_4Zo_7JzOV5W-Ao0f0ol7_ldbHP4GL7WVOTyXQGzOvh98vGWb53SwgkogxtY-2.png)
Once the API Key, Webhooks, and PublicIDs are provided to your RippleMatch team, we will set up a test role with those credentials and a test candidate to test and ensure a successful integration.