Set up the CodeSignal <> RippleMatch integration

In this article we will show you how to:

• Create an API key to provide to Ripplematch
• Create a Webhook to use RippleMatch end point
• Enable on Specific Roles
• Gather CodeSignal Test IDs
• Test and Finalize the Integration

Prerequisites

First, make sure you have the following permissions:

• Your organization must have the APIs & Webhooks enabled on CodeSignal
• You must have the admin role in CodeSignal

Create an API key to provide to RippleMatch

1. From your CodeSignal client dashboard, navigate to the API Keys page (Integrations > API Keys) and click the ADD A KEY button.

2. In the Key Description field type “Ripplematch integration” and “Next”.
   
3. In the pop-up modal, make sure All the permissions are selected and click SAVE.
   
    

4. Copy the API key from CodeSignal by clicking on the key (in blue text) to share with the Ripplematch team.
   
    

Create a Webhook to use the RippleMatch end point

This allows RippleMatch to obtain information from CodeSignal.

1. Select Webhooks and click “ADD A WEBHOOK”.
   

Add this endpoint: https://app.ripplematch.com/api/v2/integrations/cs/webhooks/prescreen

Then select the following Event Types:

• preScreenResultShared
• preScreenResultVerified
• preScreenResultVerificationPending
• preScreenResultNotVerified
• preScreenExpired
• preScreenCandidateDeclined

2. Then click + ADD A HEADER. In the first box type User-Agent and in the second box type Codesignal-<company_name>.
3. As a final step, click on the Test button. If the webhook is successful then you can enable specific roles!

Enable on Specific Roles

• Please send the public ID/Name of the role you would like to enable this feature on to your RippleMatch contact.
• The public ID can be found in the browser URL when viewing role (see in grey below). 
  

Gather the CodeSignal Test IDs

The very last step is to gather your CodeSignal Test IDs to share with your RippleMatch Team. This can be found in the URL within CodeSignal. The part following tests/ is the Test ID.

If you have multiple CodeSignal assessments for different roles on RippleMatch, please make sure to note which CodeSignal Assessment IDs should be used for the RippleMatch Role Public-IDs you provided.

Test and Finalize the Integration

1. You provide API key + webhooks;
2. RippleMatch sets up test role with API key + webhooks + modified intro email;
3. RippleMatch puts test candidate with email the company can access in Live for test role;
4. You advances test candidate;
5. RippleMatch receives an email from CodeSignal and completes CodeSignal Assessment;
6. CodeSignal approves assessment;
7. You view the test candidate in RippleMatch with a score;
8. RippleMatch integrates additional live roles + integration is live.