This guide is written to allow for a self-service Byteboard-Lever integration setup; please follow the steps outlined below to complete the Byteboard-Lever integration.
Before you begin
In order to set up the Lever and Byteboard integration, you will need the following permissions across accounts:
- Lever: Super Admin
- Byteboard: Admin
Enabling the Lever and Byteboard integration
To enable the Lever integration, please visit Team Settings at https://client.byteboard.dev/settings/team. You will need to toggle the Lever Integration button to on.
1. Create & Upload Your API keys
Follow the instructions here to set up both an 1) Initial Setup API key and a 2) Permanent API key, including the permissions listed for each in the sections immediately below.
- As a Super Admin user in Lever, navigate to Settings —> Integrations and API —> API Credentials
- Click Generate New Key in the
Lever API credentials
section to create each of the needed API Keys outlined before
list stages
allows us to identify what ID is used by Lever to represent the interview stage you use for “Byteboard”. The Permanent API Key allows our team to send interview invites to candidates and update Lever with the candidate’s Byteboard results when they are done.a) Create API Key 1 — Initial Setup API Key [in Lever]
- 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
- WRITE Endpoints Permissions
Expand here for example screenshot of selecting API Key Permissions
b) Create API Key 2 — Permanent API Key [in Lever]
- Make sure to include all of the listed READ and WRITE permissions below to ensure correct integration functionality:
- READ Endpoints Permissions
- WRITE Endpoints Permissions
Expand here for example screenshot of selecting API Key Permissions
2. Once you’ve added all the permissions listed above, click DONE at the bottom of the page to save and create the API Key.
- Toggle On the ‘Allow access to confidential data’ if you would like to give this API Key access to confidential job postings, opportunities, and requisitions in your Lever instance. Otherwise, you can leave this toggled Off.
3. 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
a) Configure Stages
- Click the ‘Configure Stages’ button on the team settings page under the
Configure Archive Reasons and State Changes
heading.
- Upload your Setup API key from step 1 and click Submit.
- *Please still keep this key saved for step 2b (Configure Archive Reasons)
- You will then be directed 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:
- Byteboard: The stage you would like to send a Byteboard interview at
- i.e., once a candidate is sent to this Stage in Lever, they’ll be sent a Byteboard interview invitation through the Lever integration
- Onsite: The stage after the Byteboard interview in your process
- i.e., the stage that indicates the candidate moved forward in your interview process post Byteboard, even if your org does not label this as “onsite interview”
- Offer: The stage that indicates a candidate received an offer
Expand here for example screenshot of the completed Lever stage mappings
b) Configure Archive Reasons
- Click the ‘Configure Archive Reasons’ button on the team settings page under the
Configure Archive Reasons and State Changes
heading.
- Upload your Setup API key from step 1 again and click Submit.
- You will then 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
- Map sure that each of the archive reasons has been mapped (they save automatically once an option is selected) before clicking out of the Lever Archive Reasons page
Expand here for example screenshot of the completed Lever Archive Reasons mappings
The following chart shows some common archive reasons that are utilized in Lever:
Byteboard Lever Integration Field | Lever Archive Reason Examples |
Rejected | Not a fit, Underqualified, Preferred another candidate, Overqualified, Keep for future opportunities, Motivations Misalignment,
Misaligned values, Plagiarism, Junior for role |
Withdrew | Withdrew |
Offer Accepted | Hired |
Offer Declined | Offer declined, accepted another offer |
Not Applicable | Duplicate application, Unresponsive, Timing, Position closed, Location, Visa Status, Better for another role, Compensation Misalignment, Expired, Distance |
3. Set Up Web Hooks
Follow the instructions here and complete the steps below to set up the two web hooks needed for this integration:
- As a Super Admin user in Lever, navigate to Settings —> Integrations and API —> WEBHOOKS:
- You will need the urls from the team settings page under
SETUP WEBHOOKS
- Create one web hook 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
- Create one web hook 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 web hook 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
Verify Connection
in Lever on the web hook page), the request will fail. This is expected and does not mean your integration does not work.4. Set Up Byteboard Tags
- Visit the team settings page of the Byteboard client dashboard to find
Your Tags
under Lever integration.
- Add these tags to a candidate record in Lever, starting with a test candidate if you would like.
- To do so, click the paper icon (copy) next to the desired Byteboard interview type to the right, and paste it as a tag on the candidate record in Lever
5. Upload Your Signing Tokens
- Follow the instructions here to generate signing tokens and copy them.
- You will need to generate one for each web hook (stage change and archive reason)
- Reference step 3 above (creating the web hooks) to see where you can access the signature tokens and copy them over from in Lever
- Upload your tokens to the team settings page under
Upload Your Signing Tokens
: - Once you’ve copied and pasted the two signature tokens, click Submit to save them
Testing the Lever Integration
Follow these steps below to send a test candidate Byteboard interview from your Lever instance and view the end-to-end data that is transmitted via the integration:
- Create a test candidate in Lever using the email of your Byteboard representative.
- Using the Byteboard team member’s email address ensures that we can “take the interview” and grade it according to complete the test
- Apply a tag from the
Setup 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
- The tag MUST be applied to the candidate before moving on to step 3 below
- Move the candidate to the Byteboard stage.
- This is the stage in your Lever instance that you mapped to correspond with sending the Byteboard interview invites.
- 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
- Your Byteboard representative will verify once the test candidate was processed correctly.
- This includes “taking the test interview” and “grading the test interview”
- Verify that there is a note in the Byteboard stage in the Lever UI with the candidate’s finalization information.
*This note will appear on the Lever candidate record — expand below for example image
- Move the test candidate to the onsite stage in Lever.
- This should be the stage that was mapped to correspond with Byteboard’s Onsite option for candidate Next Steps
- Reject the test candidate in Lever.
- Select an Archive Reason that was mapped to a corresponding Offer Status option in your Byteboard portal.
- Your Byteboard representative will verify that the candidate’s next steps and offer status were updated and set correctly according to the integration configuration.
- Once the integration test is verified, reach out to your Byteboard representative if you’d like the test candidate record to be removed from your Byteboard portal.
Cleanup [optional]
- Delete the Setup API Key [recommended, but optional]
- Once your Lever integration setup is complete and your Byteboard representative has verified that everything is working as expected, you can delete the Setup API key in your Lever instance (the key with the setup permissions)
How to send a Byteboard Interview invite from Lever
- Add the tag for the Byteboard Interview Type that you would like the candidate to receive to the candidate record in Lever.
- Byteboard Admins can find and identify the correct tag by going to the Lever Integration section of your Team Settings page, step #4, and copying the related tag name.
- Move the candidate into the Lever Stage configured for Byteboard.
- This is the action that sends the invite
- Confirm that a Note has been added to the candidate in Lever indicating that the invite has been sent .
- You can also confirm directly from client.byteboard.dev/ by checking for the candidate in the Candidates tab —> Invited candidates.