You must work with the third-party integration developer Modulus Data to use the integration with Predictive Index.  Please contact to inquire about a subscription to the Modulus Data integration with Greenhouse.


  • One-time Setup Fee
  • Annual Subscription Fee
  • Fees calculated as a percentage of PI annual subscription

Greenhouse and The Predictive Index (PI) have created an integration through a provider named Modulus Data so that your organization can seamlessly add PI assessments to your Greenhouse interview pipeline and see results within Greenhouse. In this article, we will cover:


Set Up The Predictive Index Account for Integration

Organizations who wish to create this integration must first have a subscription with The Predictive Index. If your organization does not yet have a subscription it can be obtained by visiting: The Predictive Index Business Inquiry

Additionally, speak to the PI integration team ( about a subscription to the Modulus Data integration with Greenhouse. The PI integration team will work with you and Modulus Data to arrange your contract with Modulus Data to pay the integration setup and annual subscription fees (which are calculated as a percentage of your PI subscription fee). 


Generate Greenhouse Recruiting API Key

To create a Harvest API key for the integration, click the Configure icon Configure.png in the upper right-hand corner. 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 The Predictive Index.


In the Create New Credential dialog box, make the following selections:

  • API Type: Harvest
  • Partner: The Predictive Index
  • Description: The Predictive Index Harvest API Key

When finished, click Manage Permissions to generate the Harvest API key and automatically assign it the appropriate permissions required by The Predictive Index.


In the subsequent dialog box, click Copy to save your API key to your clipboard. Store the API key in a secure location to provide to The Predictive Index in the next step. Click I have stored the API Key once you have copied and saved the key.

Note: You cannot access the full Harvest API key again after clicking I have stored the API Key. If you lose your API key and need to access it later, you must create a new API key, provide it to the integration partner, and then revoke access to the original key.


On the subsequent page, confirm all permissions are assigned to your new API key. If any permissions are not checked, place a check in the box next to the appropriate permission. Click Save when finished. 


Note: The Predictive Index integration uses Select all to grant all permissions. This may be more than PI needs; however, they are evolving their use of the API and do not want to have to revisit permissions for each customer.

Your Harvest API key for the Greenhouse Recruiting / The Predictive Index integration is created and configured. Provide your Harvest API key to your PI integration technician so they can set up the integration.


Configure Greenhouse Webhooks

Please speak to your Modulus integration technician about how to configure the integration's webhooks and custom options. Below are reference steps:

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 be directed to a new page where you Create a New Web Hook. From this page provide the following details:

  • Name: we suggest PI Integration
  • When: Be sure to select the right web hook so that the web hook fires at the appropriate event in Greenhouse
  • Endpoint URL: The Endpoint URL received from the PI
  • Secret Key: The Secret Key received from the PI

Note: Modulus Data will supply the webhook endpoint URLs and the credentials to be placed into the Advanced Settings … Username and Password fields.

When finished, click Create Web hook.

Modulus Data Component Greenhouse Name GH When Description
Greenhouse to PI Assessment Request “PI Stage Changed” Candidate has changed stage MD webhook URL to be placed into GH that GH will trigger upon Stage Change to send assessments if necessary.
PI to Greenhouse Results PI Refresh BA or CA Candidate or Prospect Updated URL of the webhook that'll trigger a result refresh into GreenHouse from PI.


Adding a Job Target in the PI software

Add a Job Target to the PI system that describes the range of ideal employees for any Job you intend to define in Greenhouse.

From the left-side navigation, under the Hire header, choose Create Job. Fill out the Create Job form with a unique name and then click Next. Choose a method to determine the behavioral and/or cognitive target(s) for the Job and complete that process. You can use a single PI Job Target for multiple Greenhouse Jobs that all require people with the same range of behavioral patterns.  


Configure PI Settings for a Greenhouse Job

Each Greenhouse Job that you wish to trigger PI assessments must be configured to do so using three custom fields in the Job Info.

Navigate to a specific job and click Job Setup. From the Job Setup page, navigate to Job Info on the left-hand panel.

Scroll down to the PI custom fields and choose a value from each drop-down

Pi_assessment_type - choose Behavioral or Both (Behavioral and Cognitive)

Pi_process_stage - choose from the list of stage names to indicate which Interview Plan stage should serve as the trigger of the PI assessments.

If you don’t see the stage name you need in this location, an Administrator will need to add any needed stage names to the list using the Configure configure.png > Custom Options > Custom Company Fields > Jobs view, then edit the field options:

Pi_job_target - Choose a job from the drop-down list. The list of jobs is automatically updated from the PI system on a nightly basis. If you need a job to appear right away in the list, you can ask an Administrator to add the PI Job Target name to the list using the same Manage Job Fields view as referenced above.


Add New Interview Stages in Greenhouse

A typical way to configure Greenhouse is to use two stages: one to send an email acknowledging the application and helping the candidate to expect the assessment messages, and another to actually send the assessment invitation(s).

To add the stages to your Interview Plan:

Navigate to a specific job, and click the Job Setup. From the Job Setup page, navigate to Interview Plan section:

At the bottom of the stage list, click Add a Stage.

Choose the top item, Create New Stage, and type a name Send Assessments and click the Add button.

Repeat this Add a Stage action but this time add a Take Home Test stage.



Configure the Stages

Locate the new Send Assessments stage, click the X next to the name of the Interview within this new stage to delete the Interview component. You will see a confirmation box like this in which you should click Confirm Delete:

Edit the name of the new Take Home Test stage to become Pre-Assessment Email or similar

Edit the name of the content item in the stage, and name it something like Acknowledge App and Intro Assessment.

Click the Edit icon for the content item, create your email message, and deactivate the following:

  • Link for candidates to submit tests
  • Graders and Notifications
  • Additional Settings

When finished, click Save.


Sending and Review the PI Assessments

First, move candidates into the Pre-Assessment Email Greenhouse will display a Send Test link. While you will click "Send Test" in Greenhouse, the message explaining the assessment(s) will be sent from Greenhouse.

Next, move candidates into the Send Assessments The integration will send a signal to the PI system which will actually send out the assessment invitations to the candidate.

Once the candidate has completed their assessment(s), the Candidate Details view will display Complete in the custom field pi_assessment_state_ba for the Behavioral Assessment and, if used, Complete in the custom field pi_assessment_state_ca for the Cognitive Assessment.

Assessment results will appear as PDF file attachments in the Candidate Details view and other results and links will display in the other custom PI fields in the same view.




WARNING: Please do not attempt to perform this work yourself — let the Modulus Data team do this. This content is for reference and support only. Changing or incorrectly creating custom fields may break your integration! 

The following custom Greenhouse fields are required for the integration. These should be created during the implementation phase by the Modulus Data integration technician. Creating these fields incorrectly will require custom fields to be maintained for your integration.


Greenhouse Custom Fields Configuration
Field Name* type Description
pi_assessment_type single select Behavioral only or Both Behavioral and Cognitive
pi_process_stage single select Determines which completed stage will trigger PI assessment invitation(s) to be sent
pi_job_target single select Select a job from the list of defined Jobs in PI software to be assigned to candidates who have applied for this Job upon reaching the assessment stage.


Greenhouse Custom Fields Configuration
Field Name* type Private Description
pi_assessment_state_ba Short textbox   “Sent” or “Completed” or “Error: {detail}”
pi_assessment_state_ca Short textbox   “Sent” or “Completed” or “Error: {detail}”
pi_fit_score_ba Short textbox   Whole number between 1 and 10 or N/A
pi_fit_score_ca Short textbox Private Whole number between 1 and 10 or N/A. Some clients may want this private, some are okay letting it be seen by users since it is a relative, not absolute, score.
pi_fit_score Short textbox   Decimal number e.g. 7.5 or 9 or 3
pi_fit_score_level Short textbox   Computed (High, Medium, Low) based on pi_fit_score ranges (>=8, >=4, else)
pi_reference_pattern_name Short textbox   Reference profile (e.g. Captain, Controller)
pi_reference_pattern_descr Short textbox   One sentence description of reference profile
pi_person_page_url URL   Clickable link to PI Person Details
pi_descriptive_report_page_url URL   Clickable link to PI Report Options
pi_cognitive_score Short textbox Private Score of the cognitive assessment.
pi_cognitive_percentile Short textbox Private Percentile of the cognitive assessment.
pi_assessment_user_id Short textbox   ID of the Person in PI platform
pi_assessment_id_ba Short textbox   ID of the Behavioral assessment.
pi_assessment_id_ca Short  textbox   ID of the Cognitive assessment.
pi_take_ba_assessment URL   URL sent to the candidate to take the Behavioral assessment. Use only for providing support to candidate.
pi_take_ca_assessment URL   URL sent to the candidate to take the Cognitive assessment. Use only for providing support to candidate
pi_refresh_ba Yes/No   Change to Yes and save to reload the Behavioral assessment and Job Fit data and associated reports
pi_refresh_ca Yes/No   Change to Yes and save to reload the Cognitive assessment data and report