How do I enable and configure the Sterling integration?

Available for User roles Super Admins, Admins, Team Members, Limited Team Members
Plans Enterprise, Professional

Please note: The Sterling integration requires set up by both the Sterling and Lever teams. If you’re interested in using Lever’s integration with Sterling, please reach out to your Sterling Account Manager in addition to reaching out to your Lever point of contact or Lever Support.

Overview

sterling-flow.png

At a high level, the Lever-Sterling Talent Solutions integration will initiate a Background Check order in Sterling when a candidate is moved to a particular stage in Lever. Overriding a default Sterling package is supported. Upon stage change, Lever will send candidate details to Sterling and Sterling will send an email to the candidate to add additional information and complete the background check. The status of the screening will be captured in Lever as tags as the screening proceeds. Displaying the screening results as Lever tags is supported as well and configurable. Once the background check is completed, Lever will update the candidate profile with a Sterling-gated link to the background check report and can optionally move the candidate to another stage in Lever.

Setup

1. Contact Sterling: Setting up the Lever-Sterling integration involves reaching out to your Sterling Account Manager to ensure your account is configured correctly for the integration. Simply request the "Standard Lever Integration" from your Sterling Account Manager.

2. Contact Lever: After your Sterling Account Manager has provided you with your Sterling Client Id, Client Secret and a list of your Sterling packages, reach out to your Lever point of contact or Lever’s support team to enable the integration. In your request, please provide the following:

  • Sterling Client Id: Lever needs the Sterling Client Id of your account to configure the integration. 
  • Sterling Client Secret: Lever needs your Sterling Client Secret in order to authenticate the integration with Sterling.
  • Trigger Stage: The pipeline stage in Lever that automatically triggers the Sterling background check package. (e.g., Background Check).
  • Default Package (Optional): The package that you want to run automatically when a candidate is advanced to the Trigger Stage. If a Sterling package name is specified in a tag on the candidate profile, we will run that specific package instead of the Default Package.
  • Stage on Clear (Optional): The pipeline stage that you want the candidate to automatically advance to when the Sterling background check clears.
  • Show Results (Optional): The results of the candidate's background check will appear as a tag on their profile (e.g., "sterling - alert", "sterling - clear", or "sterling - n/a"), should you decide to enable this functionality.

Once you have sent Lever this information, the appropriate API key and webhook settings will be configured in your Lever account. Do not delete these, or the integration will stop working!

Creating a Sterling Order from Lever

Once you’ve completed setup, any candidate that is advanced to your Trigger Stage will be sent an email from Sterling to complete the background check. Lever will send candidate details including name, email address, and the candidate's Lever Candidate Id to Sterling. This data will be used to pre-populate a Sterling order for the candidate as demonstrated in the flowchart and screenshot below. In this example, the tag "Standard Package 1" is the name of the Sterling package used for the candidate's background check.

package-screenshot.png

The candidate will then receive an e-mail invitation from Sterling to begin the background check process. Once the invitation has been sent, Lever will add the tag "sterling - new" to the candidate profile. The candidate then fills out the Sterling background check form. Once the candidate finishes filling out the form, the tag “sterling - pending” is added to the candidate profile. There will only be one Sterling status tag on a candidate's profile at any given time. 

A full table of the possible tags can be seen below. There will only be one Sterling tag on a candidate's profile at any given time.

Sterling Order Status

Lever Tag

new

sterling - new

cancelled

sterling - cancelled

pending

sterling - pending

error

sterling - error

release

sterling - release

completed

sterling - completed

 

Once the candidate has been sent to Sterling, you'll be able to see the pending Sterling invitations in the Upcoming Due Dates section in the Sterling dashboard: 

 

Once the candidate submits the background check form, the Sterling status will change to “sterling - pending”. When the background check is complete, the tag in Lever will change to "sterling - completed" as demonstrated in the screenshot below.

Screen_Shot_2018-06-26_at_2.46.48_PM.png

When the detailed background check report becomes available, the integration will add a gated Sterling link to the links section of the candidate profile as shown in the above screenshot. You will need to login to Sterling to view this link. 

Overriding your Default Package

During setup, you have the option to provide a default package to send to all candidates that reach the trigger stage. However, you can also run different packages for different roles and candidates! In order to override the default package (or select a package if you did not provide a default package), simply add a tag with the name of the Sterling package to the candidate's profile before advancing them to the trigger stage! Remember that you can automatically tag candidates on Posting-by-Posting basis. 

Drop us a note if any questions come to mind. We're always happy to help!

Have more questions? Submit a request
Powered by Zendesk