About Lever Integration

Before you begin

• Lever: Super Admin

• Byteboard: Admin

Enabling the Lever and Byteboard integration

1. Create & Upload Your API Keys

1. Initial Setup key

2. Permanent API key

1. As a Super Admin user in Lever, navigate to Settings > Integrations and API > API Credentials.

2. Select Generate New Key in the Lever API credentials section to create each of the needed API Keys outlined before

Initial Setup Key

1. Make sure to include all of the listed READ and WRITE permissions below to ensure correct integration functionality (by clicking the related checkboxes in the endpoints sections):
• READ Endpoints Permissions
[Setup only] list opportunities: list all opportunities
[Setup only] list opportunity notes: list all notes
[Setup only] list stages: list all stages: /stages
[Required] list archive reasons: list all archive reasons
[Required] read opportunity: read a single opportunity
[Required] read archive reason: read a single archive reason
• WRITE Endpoints Permissions
[Setup only] delete opportunity note: delete a note
[Required] create opportunity note: add a note
Expand here for example screenshot of selecting API Key Permissions

Permanent API Key

1. Follow the steps outlined above to create the API key

2. For the Permanent API key, ensure all of the listed READ and WRITE permissions below to ensure correct integration functionality:
• READ Endpoints Permissions
[Required] list archive reasons: list all archive reasons
[Required] read opportunity: read a single opportunity
[Required] read archive reason: read a single archive reason
[Required] read interview: find a candidate interview
• WRITE Endpoints Permissions
[Required] create opportunity note: add a note
Expand here for example screenshot of selecting API Key Permissions



 
🛑
Before you fully submit the page to create the Permanent API Key, make sure to copy the full Permanent API Key (screenshot below) and store it in a safe location on your device. You will need to submit the full Permanent API key in your Byteboard portal. You will not be able to access the full API key again once it’s been created.

1. Once you’ve added all the permissions listed above, click DONE at the bottom of the page to save and create the API Key.

2. If you would like to give the API Key access to confidential job postings, opportunities, and requisitions in your Lever instance, toggle the Allow access to confidential data. Otherwise, you can leave this toggled off.

1. Once API key creation is completed in Lever, add your permanent API key to the team settings page in the Byteboard portal in the permanent key box in Step 1 and click Submit.

2. Configure Stage Changes and Archive Reasons

Configure Stage Changes

1. Click the Stage Changes button on the Byteboard Team Settings page under the Configure Archive Reasons and State Changes heading.

2. Insert your Initial Setup Key, click Submit. You’ll want to keep this API key saved for the Configure Archive Reasons set-up stage.

3. You will bedirected to match your company’s Lever stages to the appropriate Byteboard Stages. Select the Lever Stages that should be mapped to the stages listed below and once an option is selected for each, click Map Stages. Below is a recap of the relevant stage names

Byteboard Stage	Pipeline stage to send CoreEval interview
Onsite Stage	Pipeline stage immediately following CoreEval interview (applicable even if your organization does not have an onsite stage label
Offer Stage	Pipeline stage that indicates candidate has received an offer.

 

💡

If the stages in your Lever account change in the future, you can click back into the the ‘Configure Stages’ button on the team settings page, re-enter the Setup API Key (or create a new one), and click Edit to re-map the stages to Byteboard as needed. Once the changes are applied, click Map Stages again to save the new mappings.

Configure Archive Reasons

1. Click the Configure Archive Reasons button on the Byteboard Team Settings page under the Configure Archive Reasons and State Changes heading.

2. Upload your Initial Setup Key and click Submit.

3. You will be directed to match your company’s Lever archive reasons to the appropriate Byteboard Archive Reason. Select the Byteboard Offer Status option that should be mapped to each of the Lever Archive Reasons stages by clicking the arrow next to that Archive Reason and selecting the appropriate value (e.g., if a candidate is archived in Lever with the reason Underqualified, you may choose to map that value to the Byteboard ‘Rejected’ value for the candidate’s Offer Status).

Expand here for example screenshot of the completed Lever Archive Reasons mappings

1. Each archive reason must be mapped in order for the Lever integration to work.

2. Your candidates’ Byteboard Offer Status data will begin to populate automatically via the integration for future candidates once they are archived in Lever

3. Set Up Web Hooks

1. Navigate to Settings > Integrations and API > WEBHOOKS.

2. You will need the urls from the Byteboard Team Settings page under SETUP WEBHOOKS

3. Create one webhook for the Candidate State Change event (leverStageChange)
• A. Toggle on the Candidate State Change event and click + Add webhook
• B. Copy the State Change web hook URL from the Byteboard portal by clicking the Page icon next to it
• C. Paste the Stage Change URL from the Byteboard Team Settings page (step 3 in Lever setup) directly into the Lever URL box
• D. Copy the Signature token for the State Change web hook and store it in a secure place
ℹ️
You will need the signature token for this webhook to use in the Upload Your Signing Tokens setup process.

4. Create one webhook for the Candidate Archive State Change event (leverArchiveChange)
• A. Toggle on the Candidate Archive State Change event and click + Add webhook in that section
• B. Copy the Archive Change webhook URL from the Byteboard portal by clicking the page icon next to it
• C. Paste the Archive Change URL from the Byteboard Team Settings page (step 3 in Lever setup) directly into the Lever URL box
• D. Copy the Signature token for the Archive Change web hook and store it in a secure place
ℹ️
You will need the signature token for this web hook to use in Upload Your Signing Tokens setup process.

4. Set Up Byteboard Tags

1. Visit the Byteboard Team Settings page to find tags under the Setup Byteboard Tags section

2. Add these tags to a candidate record in Lever.

3. To add a tag, click the paper icon (copy) next to the desired Byteboard CoreEval assessment type to the right, and paste it as a tag on the candidate record in Lever

1. Tags must be used for all candidates that you are inviting to take Byteboard CoreEval interview through Lever; if tags are not used, Byteboard is unable to identify which CoreEval interview type to send to the candidate. Once you’ve added a tag to at least one candidate in Lever, the tags should auto-populate for future candidates you’d like to invite to the same interview type.

2. Byteboard tags must be added to a candidate before the candidate is moved to the Lever stage that is mapped to Byteboard Stage, or else the Byteboard CoreEval interview invite will not be delivered.

3. If you add new Byteboard CoreEval interview type to your account at any point via https://client.byteboard.dev/assessments/coreeval, visit the Byteboard Team Settings page in to copy over the new tag to Lever for use.

4. Tags are case sensitive and must match exactly how they are displayed in team settings page.

5. Upload Your Signing Tokens

1. Follow Lever’s instructions on Securing webhooks documentation to generate signing tokens and copy them. You will need to generate one for each web hook (stage change and archive reason). Reference 1. Create & Upload Your API Keys to view where you can access the signature tokens and copy them over from in Lever

2. Upload your tokens to the Byteboard Team Settings page under Upload Your Signing Tokens Once you’ve copied and pasted the two signature tokens, click Submit to save.



Note, Byteboard will indicate once you have already submitted your signing token(s).

Testing the Lever Integration

1. Create a test candidate in Lever using the email of your Byteboard point of contact.
• Using the Byteboard team member’s email address ensures that we can “take the interview” and grade it according to complete the test

2. Apply a tag from the 4. Set Up Byteboard Tags section of your Byteboard Team Settings page to the test candidate record in Lever.
• You can use the corresponding tag for any of the Interview Types you have set up in your Byteboard account. Note, the Byteboard tag must be added to the candidate before moving forward with next step.

3. In Lever, move the candidate to the pipeline stage corresponding to Byteboard Stage. Note, this is the stage in your Lever instance that you mapped to correspond with sending the Byteboard CoreEval interview invites.

4. Verify that there is a note in the Byteboard stage in the Lever UI indicating that the invite was sent.
This note will appear on the Lever candidate record — expand below for example image

5. Your Byteboard point of contact will verify once the test candidate was processed correctly. This includes “taking the test CoreEval interview” and “grading the test CoreEval interview”

6. Verify that there is a note in the Byteboard stage in the Lever UI with the candidate’s completed CoreEval interview information.
This note will appear on the Lever candidate record — expand below for example image

7. Move the test candidate to the onsite stage in Lever. Note, this should be the Lever pipeline stage that was mapped to correspond with Byteboard’s Onsite Stage.

8. Reject the test candidate in Lever. Select an Archive Reason that was mapped to a corresponding Offer Stage option in your Byteboard portal.

Cleanup (optional)

 

💡

If the stages in your Lever instance change in the future, click back into the the ‘Configure Stages’ button on the team settings page. If you deleted your original Setup API Key, create a new one following Step 1a above, and submit it to access the View Lever Stages page. Then click Edit at the bottom of the screen to re-map the stages to Byteboard as needed. Once the changes are applied, click Map Stages again to save the new mappings.