How can we help you?

ARKiiVΞ

ARKiiVΞ INTEGRATION SETUP AND USAGE INSTRUCTIONS

 

PART 1 - CREATING AN API KEY

IMPORTANT! – IN ORDER TO CREATE API KEYS USERS NEED TO HAVE RELEVANT ADMINSTRATOR OR DEVELOPER PERMISSIONS ENABLED ON THEIR USER ACCOUNT.

 

USERS WHO DO NOT HAVE DEVELOPER PERMISSIONS ENABLED NEED TO CONTACT THEIR GREENHOUSE ‘SUPER USER(S)’ WHO WILL BE ABLE TO ENABLE DEVELOPER PERMISSIONS ON THEIR USER ACCOUNT OR OTHERWISE GENERATE THE API KEYS DIRECTLY.

 CiiVSOFT requires the Greenhouse user to create one API key for the Harvest API

 To create a Harvest API key, follow these steps:

 Step 1 - Click the Configure tab on the dashboard

 

 

Step 2 - Click Dev Center from the menu in the left hand column

 

Step 3 - Click API Credential Management from the menu in the middle column

 

 

 Step 4 - Click Create New API Key 

 

Step 5 - Enter CiiVSOFT_AKV in the ‘Description’ field then select Harvest from the dropdown list in the ‘Type’ field

Step 6 - Click Create

NOTE: You will now be directed to select / manage API endpoint permissions

Step 7 – Specify API endpoints / permissions

CiiVSOFT requires access to certain endpoints in the Harvest API. These can either be specified individually or otherwise user can ‘select all’ for simplicity.

OPTION 1 - ‘Select All’ – to select all API endpoints simply click  ‘ select all’ 

Then click ‘Update’ at the bottom of the list

OPTION 2 - Specify individual endpoint permissions

The endpoint permissions required for full functionality and stability are detailed in the table on the next page.

Endpoint Parent

Endpoint Type

Endpoint Label

Applications

GET:

List Applications

 

PATCH:

Update Application

 

POST:

Advance Application

 

POST:

Move Application

 

 

 

Candidates

GET:

List Candidates

 

POST:

Add Note

 

POST:

Add Prospect

 

 

 

Custom Fields

GET:

Get Custom Fields

 

 

 

Departments

GET:

List Departments

 

 

 

Job Posts

GET:

List Job Posts

 

GET:

List Job Posts for Job

 

 

 

Job Stages

GET:

List Job Stages

 

GET:

List Job Stages for Job

 

 

 

Jobs

GET:

List Jobs

 

 

 

Offices

GET:

List Offices

 

 

 

User Roles

GET:

List User Roles

 

 

 

Users

GET:

List Users

 

 

 

Select individual endpoints within the parent / child dropdown selection of permissions as shown in the diagram on the next page:

Then click ‘Update’ at the bottom of the list

 

STEP 8  The harvest API key is now created and shown like this:

STEP 9 - Please send a COPY of the API key via email to your CiiVSOFT Client Services Director

 

PART 2 – ADD CiiVSOFT AS A USER

To add a user, follow these steps:

Step 1 - Click the Configure tab on the dashboard

Step 2 - Click Users from the menu in the left hand column

 

Step 3 - Click + New Users from the menu in the left hand column

 

 Step 4 – Enter ciivhub@ciivsoft.com in the email field

 

 Step 5 – Set permissions for CiiVSOFT user

  1. In BASIC permissions area select checkboxes for developer permissions, then click ‘Edit’

 

  1. In Job Admin / Interviewer permissions area select checkboxes for developer permissions, then click ‘Add’

  1. In Future Job Permissions section click ‘+ Add’ next to All Future Jobs

  1. Select ‘Job Admin Standard’ from the drop down selection

 

  1. Click ‘Save’ 

 

  1. Click ‘edit’

  1. In Site Admin permissions area select checkboxes for developer permissions

  1. Lastly, enter CiiVSOFT in First name and Last Name fields and then click ‘Save’

 

 

INSTRUCTIONS FOR USING ARKiiVΞ

Using ARKiiVΞ could not be easier. It has been designed specifically to work with the Greenhouse platform and operates autonomously in the background. ARKiiVΞ automatically searches the existing greenhouse candidate database to find suitable candidates every time a new job vacancy is created. Any matching candidates are automatically assigned as new applications against the new job vacancy. ARKiiVΞ provides Greenhouse users with an invaluable, automated sourcing tool enabling them to get a head start on a new requisition and potentially save on costly talent attraction and advertising activities.


There’s no additional workload or training required, simply use Greenhouse in the normal way and ARKiiVΞ takes care of the rest.

To use ARKiiVΞ simply follow these steps:

Step 1 – Create Job in Greenhouse in the normal way but DO NOT SET JOB POST TO LIVE

Step 2 – You will receive an email requesting you to approve your job vacancy in CiiVHUB. Click the ‘My Jobs’ link. Approval emails are unique to each user and only require you to approve jobs to which you are assigned.

IMPORTANT This is your opportunity to review, edit and amend the job criteria you want ARKiiVΞ to use as the basis for searching the database. It is also a useful sanity check for the specific job vacancy requirements.

Step 3 – Select which vacancy you wish to approve by clicking the ‘Approve’ button next to your chosen vacancy

Step 4 – ARKiiVΞ automatically ingests job data from the newly created job via the Greenhouse API and applies this to machine learned data in CiiVSOFT’s systems. Review and edit the job data in the form.

 Step 5 – Once you are happy with the job data click the ‘Submit’ button

Step 6 – You will see a confirmation screen confirming your vacancy has been approved. You will also have the opportunity to approve any other vacancies which are still to be approved. 

NOTE: Job approval is a ‘one time only’ action for each job.

 Step 7 – ARKiiVΞ automatically searches the existing candidate database for matching records. When  the process is finished, you will receive an email notification from ARKiiVΞ.

 Step 8 – To view the results, simply login to your Greenhouse account and navigate to the new job vacancy. You will see matching candidates found by ARKiiVΞ waiting for you to review in the Application Review workflow stage.