Overview
This guide will walk through the steps to enter your Lever partnership credentials into Merge to allow your customers to connect their Lever accounts using OAuth.
Prerequisites
While a Lever partnership is not required for the integration, being a partner will enable an OAuth linking flow for your customer. If you are interested in becoming a Lever partner, please fill out this form.
Instructions
Step 1: Navigate to the Lever integration on the Merge Dashboard
On the Merge Dashboard, navigate to the Integrations tab
Under ATS, identify the Lever integration
Enable the integration using the toggle on the right
Step 2: Input your client credentials
Click Set up organization-level credentials
Enter the following information in the appropriate fields, which were provided to you from Lever:
OAuth Client Id
OAuth Client Secret
OAuth Redirect Uri
Once you've entered in your Lever partner credentials, the next time your users authenticate in Merge Link, they will be taken through the Lever OAuth flow!
Notes
By default, Merge requests various scopes during the OAuth2 authentication flow which you can find below:
Scope | Lever scope description | Merge scope usage |
applications:read:admin | View all opportunity applications | Retrieving Application details |
archive_reasons:read:admin | View all archived reasons | Populating the RejectReason of an application |
contact:write:admin | View and manage an opportunity's contact | Retrieving Candidate details, creating Candidate |
feedback:write:admin | View and manage all of an opportunity's feedback | Retrieving Scorecard details* |
files:write:admin | View and manage all of an opportunity's files | Retrieving Attachment details, creating Attachment |
forms:write:admin | View and manage all of an opportunity's forms | Retrieving ScreeningQuestion details, creating Application with ScreeningQuestionAnswer |
interviews:write:admin | View and manage all of an opportunity's interviews | Retrieving ScheduledInterview details, creating ScheduledInterview |
notes:write:admin | View and manage all of an opportunity's notes | Retrieving Activity details, creating Activity |
offers:read:admin | View all of an opportunity's offers | Retrieving Offer details |
offline_access | Include this scope in the authorize call in order to get a refresh token during the token exchange | Ensuring data can be synced in the background |
opportunities:write:admin | View and manage all opportunities | Retrieving Application details, creating Application |
panels:write:admin | View and manage all of an opportunity's panels | Creating ScheduledInterview |
postings:write:admin | View and manage all postings | Retrieving JobPosting details, creating Application |
referrals:read:admin | View all of an opportunity's referrals | Not currently in use* |
requisition_fields:write:admin | View and manage all requisition fields | Not currently in use* |
requisitions:write:admin | View and manage all requisitions | Not currently in use* |
resumes:read:admin | View all of an opportunity's resumes | Retrieving Attachment details |
sources:read:admin | View all sources | Retrieving Application.source values |
stages:read:admin | View all stages | Retrieving JobInterviewStage details |
tags:read:admin | View all tags | Retrieving Tag details |
uploads:write:admin | Manage all file uploads | Creating Attachment |
users:write:admin | View and manage all users | Reading RemoteUser, creating RemoteUser |
webhooks:write:admin | Manage all webhooks | Managing webhooks in order to ensure Merge can process Lever updates in real-time |
Scopes marked with * are either partially used or not used at this time. These are in place to accommodate the upcoming merge functionality. Replacing them with read-only scopes, or removing them where appropriate, will not break existing functionality, but would mean that end users would have to go through the authentication flow again when new Merge functionality is made available.
The scopes requested in the authentication flow can be customized to suit your exact use case and partnership agreement with Lever. Contact [email protected] with any changes you'd like to see implemented.