is a powerful, easy-to-use system for companies hiring skilled foreign talent. Designed with simplicity and efficiency in mind, allows HR and legal teams to manage immigration processes and compliance requirements for seamless recruiting and faster onboarding.

Greenhouse Recruiting's integration with allows your recruiters to request pre-hire immigration assessments directly from Greenhouse Recruiting for faster onboarding and a better candidate experience. 

In this article, we will cover: 


Configure User Setup Permissions in Greenhouse Recruiting

In order to enable the Greenhouse Recruiting / integration, you will need the following developer permissions:

  • Can manage ALL organization’s API Credentials
  • Can manage and configure web hooks

Contact a Greenhouse Recruiting user in your organization with Site Admin level permissions with the additional user-specific permission Can edit another user's advanced permissions to apply the API credential management permission to your account. Have the user with Site Admin level permissions edit your user account's permissions by navigating to the Configure icon  > Users > Your Name.


The user with Site Admin level permissions should navigate to the User-Specific Permissions panel on your user page and expand the Developer Permissions dropdown menu. 

Select Can manage ALL organization’s API Credentials and Can manage and configure web hooks so that a check is in each checkbox. When finished, click Save.


Repeat as necessary for any other user that should have access to set up the integration.


Enable the Greenhouse Recruiting / Integration

Contact your representative to receive your API key. Once you have received your API key, click here to open a ticket with the Greenhouse Support team. 

Note: Do not send the API key in this initial email.

The Greenhouse Support Team will respond with a SendSafely link for you to enter your API key. A notification will be sent to the Greenhouse Support Team after you have entered your API key and they will email you to confirm that your API key has been set up in your account and your integration is enabled.

Note: To verify your identity, the Greenhouse Support Team might request you provide a Support Verification Code before adding the API key to your organization's account.


Add Stage to Job's Interview Plan

Once the Greenhouse Recruiting / integration is enabled for your organization, you will be able to add the assessment as an Interview stage.

To do this for an existing job, navigate to a job (All Jobs > Job Name) and click Job Setup from the Job navigation bar.


From the Job Setup page, navigate to Interview Plan on the left-hand panel. Scroll down the page and click + Add a Stage.


From the Add Stage dialog box, select the stage. When finished, click Add at the bottom of the dialog box to add the Pre-Hire Immigration Assessment ( stage to the job's interview plan.



Configure Custom Candidate Field

From your Dashboard, click the Configure icon Configure.png in the upper right-hand corner and navigate to Custom Options on the left-hand panel. 


On the subsequent page, click Candidates under the Company Custom Fields section.


On the Custom Fields: Candidates page, click Add Field.


Enter in the following information below for the Field Name and Type.

Note: Be sure to enter the words exactly as shown below, including capitalization and spaces.

  • Field Name: Requires Immigration Sponsorship
  • Type: Yes/No

Click Save.


Your newly created field will now be part of your company’s library of candidate fields, and will be shown under the Details tab of a candidate’s profile.



Configure Web Hooks

Before enabling the Greenhouse Recruiting / integration, Greenhouse Recruiting will need a few pieces of information: 

  •'s Secret Key
  • Username
  • Password

Please reach out to the team to retrieve your Secret Key, Username, and Password. 

Once you have received your Secret Key from, you are ready to enable the web hooks. Click the Configure icon Configure.png in the upper right-hand corner and navigate to Dev Center on the left-hand panel. From the Dev Center page, click Web Hooks.


Click Web Hooks from the subsequent page.


You will create two web hooks for the integration. On the Create A New Web Hook page, provide the following details to create the first web hook: 

  • Name: create_candidate
  • When: Candidate has changed stage
  • Endpoint URL: 
  • Secret Key: The Secret Key received from the team
  • Error recipient email: 

Click Advanced Settings and enter the following details: 

  • Username: The Username received from the team
  • Password: The Password received from the team
  • Maximum Attempts: 3

When finished, click Create Web hook


Repeat the steps above to create a second web hook using the following details: 

  • Name: update_candidate
  • When: Candidate or Prospect updated
  • Endpoint URL:
  • Secret Key: The Secret Key received from the team
  • Error recipient email: 

Click Advanced Settings and enter the following details: 

  • Username: The Username received from the team
  • Password: The Password received from the team
  • Maximum Attempts: 3

Click Create Web hook when finished. 


Create Harvest API Key for the Greenhouse Recruiting / Integration

To create a Harvest API key for the integration, click the Configure icon Configure.png in the upper right-hand corner and navigate to Dev Center on the left-hand panel. From the Dev Center page, click API Credential Management.


From the API Credential Management page, click Create New API Key to generate the API key for


From the Create new credential dialog box, give your API key a name and select Harvest from the Type dropdown menu. When finished, click Create.


On the Manage API Key Permissions page, grant your API key the following permissions:


  • GET: Retrieve Application
  • GET: List Applications


  • GET: Retrieve Candidate
  • GET: List Candidates

Job Posts: 

  • GET: List Job Posts
  • GET: Retrieve Job Post for Job
  • GET: List Job Posts for Job


  • GET: List Application’s Offers
  • GET: Retrieve Application’s Current Offer
  • GET: Retrieve Offer
  • GET: List Offers


  • GET: Retrieve Office
  • GET: List Offices


  • GET: List Tags Applied to Candidate
  • GET: List Candidate Tags

When finished, click Update.

Copy your Harvest API key and securely send it to the team to complete the integration setup. 


Use Greenhouse Recruiting / Integration

Now that you have set up the integration, you can move forward with requesting an assessment for any candidates who indicate they need immigration sponsorship.

Step 1: Confirm the Candidate Requires Immigration Sponsorship

When the candidate indicates that they now or will in the future require immigration sponsorship, make sure to indicate this under the Details tab in their candidate profile by selecting Yes in the custom candidate field Requires Immigration Sponsorship, as indicated below.


Note: If you select No or leave the custom field indicated above blank, you will receive an error message and email notification indicating that you will not be able to send the Pre-Hire Immigration Questionnaire to the candidate.


Step 2: Initiate the Immigration Assessment Request

When you are ready to request an immigration assessment, move the candidate to the Pre-Hire Immigration Assessment stage. Once the candidate is moved to the Pre-Hire Immigration Assessment stage, click Send Test to send the questionnaire to the candidate.


The questionnaire will be emailed to the candidate, copying a primary contact and the assigned recruiter in Greenhouse.

Step 3: Receive the Immigration Assessment

The assessment will be issued based on the completed questionnaire, the candidate’s resume/CV, and the details of the offered position harvested from Greenhouse. The recruiter will then receive an email with the assessment.

Get Help

Questions? Contact for troubleshooting assistance regarding the integration.