About Cleary:
Welcome your employees to the digital lobby for distributed teams.
Deliver a world-class digital employee experience for every moment that matters from onboarding and beyond.
Greenhouse Recruiting’s integration with Cleary will sync all your hired candidates from Greenhouse into Cleary to guide them in the days before they join your company.
Configure setup permissions in Greenhouse Recruiting
To configure the Greenhouse Recruiting / Cleary integration, you’ll need the developer permission Can manage ALL organization’s API Credentials.
To assign this permission, find a Greenhouse Recruiting user in your organization with Site Admin permission and the user-specific permission Can edit another user's advanced permissions to update your account.
The Site Admin can update your permissions by navigating to your user page. Click the Configure icon > Users > Your Name.
The Site Admin should scroll 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 in the Developer Permissions section and click Save.
Repeat as necessary for any other user that needs to set up the integration.
Create a Harvest API key for the Greenhouse Recruiting / Cleary integration
Note: To generate an API key, you must have the developer permission Can manage ALL organization's API Credentials.
Click on the Configure icon and select Dev Center on the left.
Select API Credential Management in the Dev Center.
From the API Credential Management page, click Create New API Key to generate the API key for Cleary.
In the Create New Credential box, make the following selections:
- API Type: Harvest
- Partner: Cleary
- Description: Cleary Harvest API Key
Click Manage Permissions.
Click Copy to save your API key to your clipboard. Store the API key in a secure location to provide to Cleary in the next step.
Click I have stored the API Key once you have copied and saved the key.
Note: You won’t be able to view the API key after clicking I have stored the API Key. If you lose your API key or need to access it later, you’ll need to generate a new key and provide it to Cleary.
Select the checkboxes next to each permission box to associate it with the API key.
The following permissions are needed for thee Cleary integration:
- Candidates: Get: Retrieve Candidate
- Offers: Get: List Offers
- Jobs: Get: Retrieve Job
- Users: Get: Retrieve User
When you’re finished, click Save.
Your Harvest API key for the Greenhouse Recruiting / Cleary integration is created and configured.
Setting up the integration in Cleary
Note: you must be a Super Admin or have the IT Manager permission to be able to set up the integration.
- Go to the Admin section of Cleary by clicking Admin on the top navbar.
- Open the App Integrations page by clicking App Integrations on the admin sidebar.
- Expand the People Section by clicking the Show button
- You should see an input for the Greenhouse API Key. Enter the API Key and click Submit.
- The page should refresh, and now Greenhouse should appear as being connected.
Use the Cleary integration with Greenhouse Recruiting
Note: you must be a Super Admin or have the User Manager permission to be able to use the integration.
- After the integration is complete, candidates who have been marked as hired in Greenhouse will be synced into Cleary daily.
- You can view the results of these syncs in the User Imports page.
- The following fields will be synced from Greenhouse.
- id
- first name
- last name
- personal email
- phone
- start date
- manager
- title
- If you'd like other fields that exist in Greenhouse to sync to Cleary, please reach out to a member of the Cleary team.
And a detailed report after clicking on View Results.
- These new users will have access to a limited Preboarding Experience until they join the company. They’ll be able to receive email notifications from any onboarding communications or tasks you send them via Journeys. You can view their details in the Users admin page.
- Candidates that have a start date in the future will show up in the “New Hires Preboarding” tab.
- Candidates that don’t have a start date, or have a start date in the past, will show up in the “Action Needed” tab.
- For these users to have full access to the Cleary Platform you will need to take action via one of the following methods:
- If you are using an HRIS:
- When that person is added to the HRIS, Cleary will try to match them with the corresponding Greenhousecandidate.
- If they are correctly matched, the user will automatically have full access to Cleary on their start date.
- If they are not matched due to insufficient information, you can merge Greenhouse candidates with users created from the HRIS sync in the Users Page.
- When that person is added to the HRIS, Cleary will try to match them with the corresponding Greenhousecandidate.
- If you are using an HRIS:
- Clicking on merge will open up this modal, select the correct user and click the “Merge” button.
- If you are not using an HRIS:
- You must add the candidate’s company email address to the Primary Email field. They will gain full access on their start date.
Manually Syncing
- Visit the User Imports Page.
- Click on the Sync Greenhouse button at the top.
Additional resources
For additional information not covered here, reach out to support@gocleary.com