| Available for | Roles | Super Admin, Admin, Team Member, Limited Team Member Can only be enabled by Super Admins |
| Permissions | • (To enable) Manage API credentials and manage integrations • (To use) Manage profiles and view associated postings |
|
| Packages | LeverTRM, LeverTRM for Enterprise |
The Byteboard integration allows users to seamlessly invite candidates to take ByteBoard interviews and review results directly within Lever.With the Byteboard integration, you will not need to visit byteboard.dev/client to input candidate outcomes (Next Steps and Offer Status), which allows the Byteboard team to seamlessly recalibrate your recommendations and offer you metrics on your hiring process with Byteboard. Note: This is a specialized integration that is built, managed, and supported by the Byteboard team. If you would like more information or help with this integration, please contact Byteboard.
Setting up the Byteboard integration
|
|
You must be a team or organization with admin rights in Byteboard to install this integration. |
- Have a Byteboard admin visit the Team Settings page of the Byteboard client dashboard, and toggle the Lever Integration button ‘on’
Generate and upload API keys
You will be setting up two API keys, the first with the permissions needed for initial setup, and the second with a reduced list of permissions. Once Byteboard is done with setup you can delete the ‘initial setup’ API key.
- Follow the instructions to set up an Initial Setup API key and Permanent API key including the permissions listed below for each.
- Once completed, add the permanent API key to the Team Settings page in permanent key box in Byteboard
- Save the setup API key for the next step
Initial setup API key permissions:
READ 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 Permissions
- [Setup only] delete opportunity note: delete a note
- [Required] create opportunity note: add a note
Permanent API Key permissions:
READ 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
WRITE Permissions
- [Required] create opportunity note: add a note
The Setup API Key allows Byteboard to pull information needed for the various parts of the integration to work. For example, 'list all stages' allows Byteboard to identify the stage ID is used by Lever to represent the stage you use for “Byteboard”.
The Permanent API Key allows the Byteboard team to send invitations to candidates and to update the Lever opportunity with the candidate’s Byteboard results when they have completed their interview.
Configuring the Byteboard integration
Configure stage changes and archive reasons
Configure stages
- In Byteboard, click the Configure Stages button on the Team Settings page under 'Configure Archive Reasons and State Changes'
- Upload your Setup API key from the previous step
- Keep this API key saved for the next step.
- You will be directed to match your company’s Lever stages to the appropriate Byteboard Stage
- Byteboard: The stage you would like to send a Byteboard interview at
- Onsite: The stage after the Byteboard interview
- Offer: The stage that indicates a candidate received an offer
If your internal stages do not align, please feel free to reach out to your Byteboard representative.
Configure archive reasons
- In Byteboard, click the ‘Configure Archive Reasons’ button on the Team Settings page under 'Configure Archive Reasons and State Changes'.
- Upload your Setup API key again
- You will then be directed to match your company’s Lever archive reasons to the appropriate Byteboard Archive Reason.
The following chart shows some common reasons:
| 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 |
Setup webhooks
After configuring the stage changes and archive reason, you will setup the following two webhooks in Lever:
- Candidate Stage Change
- Candidate Archive State Change
On ByteBoard, reference the webhook urls from the Team Settings page under 'Your Webhooks'. You will use these urls to configure the webhooks in Lever:
- In Lever, navigate to Settings > Integrations and API > Webhooks
- Scroll to the 'Candidate Stage Change' webhook
- Click + Add webhook
- Save the signing token for this webhook for use in the following step.
- Scroll down to the 'Candidate Archive State Change' webhook
- Click + Add webhook
- Save the signing token for this webhook for use in the following step.
- Toggle the webhooks to the on (green) position if they are not already enabled
|
|
If you try to test the connection after setting up the webhooks, the request will fail. This is expected and does not mean your integration does not work. |
Upload your signing tokens
The signing token is used to verify that a request really originated in Lever. This ensures that a third-party cannot attempt to use the webhook urls to send invitations on your behalf.
- In Byteboard, upload your tokens to the Team Settings page under 'Your Signing Tokens'
Setup Byteboard tags
Add Byteboard tags to the Lever candidate opportunity to invite the candidate to a specific interview (e.g., Senior SWE, Junior Web, etc.)
- In your Byteboard dashboard, navigate to the Team Settings page to find 'Your Tags' under the Lever integration
- Add these tags to the candidate opportunity in Lever, starting with a sample candidate, if desired.
|
|
You will need to ensure that these tags are used for candidates that you are inviting to take Byteboard or the integration cannot identify which interview type to send them. |
Testing
- Create a test candidate in Lever with the email of your Byteboard representative
- Apply a tag from 'Your Tags' to the test candidate
- Move the candidate to the Byteboard stage
- Verify that there is a note in the Byteboard stage on the Lever candidate opportunity indicating that the invite was sent
- Your Byteboard representative will verify that the test candidate was processed correctly
- Verify that there is a note in the Byteboard stage in the Lever candidate opportunity with the candidate’s finalization information
- Move the test candidate to the onsite stage
- Reject the test candidate
- Your Byteboard representative will verify that the candidate’s next steps and offer status were set correctly
Cleanup
Delete the Setup API Key: Once setup is complete and your Byteboard representative has verified that everything is working, you can delete the API key with the setup permissions.
Using the Byteboard integration
Sending an invite from Lever
- Add the tag for the Byteboard Interview Type that you would like the candidate to receive to the candidate in Lever
- Move the candidate into the Lever Stage configured for Byteboar; this is the action that sends the invite
- Note: if you have not yet added a tag, no invite will be sent.
- 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 byteboard.dev/client by checking for the candidate in the “Candidates” tab.
If at any point in the process you would find it helpful to meet with Byteboard over video chat, reach out to Byteboard to setup a meeting to help with setup.
Disabling the Byteboard integration
- In Lever navigate to Settings > Integrations and API
- Under the 'API Credentials' tab, locate the Byteboard API credentials
- Click the trash can icon to disable the integration