Predictive Index (PI) integration by Modulus Data

You must work with the third-party integration developer Modulus Data to use the integration with Predictive Index. Contact integrations@predictiveindex.com to inquire about a subscription to the Modulus Data integration with Greenhouse.

Costs:

  • 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 in Greenhouse Recruiting.

Set up the Predictive Index account for the integration

Organizations must have a Predictive Index subscription to configure this integration. You can sign up for a Predictive Index subscription by filing a business inquiry.

To contact Modulus Data, contact your 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.

Create a Harvest API key for the Predictive Index integration

To configure the Greenhouse Recruiting / Predictive Index integration, you'll need to create a Harvest API key.

Follow the steps in this article to create the key, and verify that the credentials and permissions below are selected when configuring the Predictive Index integration.

Credentials

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

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

Permissions

Select all available permissions using the Select All checkbox at the top of the list.

Note: The Predictive Index integration uses Select all to grant all permissions. These permissions may be more than your integration needs to function, but ensures that the integration continues to function as the Predictive Index evolves its functionality.

Once it's generated, provide your Harvest API key to your PI integration technician so they can set up the integration.

Create a webhook

To integrate Predictive Index with Greenhouse Recruiting, you'll need to create a webhook. Follow the steps in this article to create your webhook. Use the values listed below to configure the webhooks.

You will need to create two webhooks for this integration.

Webhook 1: Greenhouse Recruiting to Predictive Index Assessment Request

  • Name: PI Stage Changed
  • When: Candidate has changed stage
  • Endpoint URL: The Endpoint URL received from the Predictive Index
  • Secret Key: The Secret Key received from the Predictive Index
  • Username: The credentials provided by Modulus Data
  • Password: The credentials provided by Modulus Data

Webhook 2: PI to Greenhouse Recruiting Results

  • Name: PI Refresh BA or CA
  • When: Candidate or Prospect Updated
  • Endpoint URL: The Endpoint URL received from the Predictive Index
  • Secret Key: The Secret Key received from the Predictive Index
  • Username: The credentials provided by Modulus Data
  • Password: The credentials provided by Modulus Data

Adding a Job Target in Predictive Index

Add a Job Target to the PI system that describes the range of ideal employees for any Job you intend to define in Greenhouse Recruiting. To make sure this information is included in the integration, you'll need to set up a Job Target in Predictive Index.

In Predictive Index, click Create Job under the Hire header and complete the fields. Then, choose a method for behavioral and/or cognitive targets and finish the setup process.

Define custom fields

Note: This step can only be completed after the Modulus Data team configures custom fields for your integration.

After the custom fields are configured by Modulus Data, you can select the correct Predictive Index values in Greenhouse Recruiting. These fields are located under the Job Info tab for each job you want to integrate with Predictive Index.

You'll need to define the following fields:

  • Pi_assessment_type: Behavioral or Both (Behavioral and Cognitive)
  • Pi_process_stage: The interview stage where PI Assessments should be sent.
  • Pi_job_target: The job in Predictive Index. The list of jobs is automatically updated from the PI system nightly. If you need a job to appear right immediately in the list, a Site Admin can add the PI Job Target Name to the custom job field options.

Create an assessment stage in your interview plan

You can create a separate interview stage to send Predictive Index assessments. Modify an interview plan and add the following stages:

  • Send assessments: Used to send an email to the candidate with the Predictive Index Assessment
  • Take Home Test: A special Greenhouse Recruiting stage used to actually send assessments to candidates.

Configure interview stages

Once you've added the stages above, make the following modifications to the interview plan:

  • Remove all interviews from the Send Assessment stage. Since scorecards won't be sent for this stage, they are not needed.
  • Update the name of the Take Home Test stage to Pre-Assessment Email, or a similar title of your choosing.
  • Update the name of the content in this stage to Acknowledge App and Intro Assessment, or a similar title of your choosing.
  • Under the stage settings, deactivate the following features:
    • Link for candidates to submit tests
    • Graders and Notifications
    • Additional Settings

Send an assessment

When a candidate is moved to the Pre-Assessment Email Stage, a Send Test link will display. Click this link to send an email to the candidate. While this button is selected in Greenhouse Recruiting, the emails will actually be sent by Predictive Index.

When a candidate is moved into Send Assessments, Predictive Index will be notified to send an assessment to the candidate.

Once the candidate has completed their assessments, the custom candidate fields will be automatically updated with relevant information:

  • pi_assessment_state_ba: Shows as "Complete" if a candidate was assigned a behavioral assessment
  • pi_assessment_state_ca: Shows as "Complete" if the candidate was assigned a cognitive assessment.

Additionally, a candidate's results will display in this field.

A PDF version of the results will automatically be attached to the candidate's profile.

 

Custom fields setup (Modulus Data reference)

Note: This section is intended for the Modulus Data team as they configure the integration. Do not attempt to perform this work yourself, as changing or incorrectly creating custom fields may cause issues with 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.

Custom job fields

Create three custom job fields using the following criteria:

Custom job field 1: Assessment Type

  • Field Name: pi_assessment_type
  • Type: Single Select
  • Description: Behavioral only or Both Behavioral and Cognitive

Custom job field 2: Process State

  • Field Name: pi_process_stage
  • Type: Single Select
  • Description: Determines which completed stage will trigger PI assessment invitation(s) to be sent

Custom job field 3: Job Target

  • Field Name: pi_job_target
  • Type: Single Select
  • Description: 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.

Custom candidate fields

Create custom candidate fields using the following options:

Field Name

Type Private Description
pi_assessment_state_ba Short textbox No “Sent” or “Completed” or “Error: {detail}”
pi_assessment_state_ca Short textbox No “Sent” or “Completed” or “Error: {detail}”
pi_fit_score_ba Short textbox No Whole number between 1 and 10 or N/A
pi_fit_score_ca Short textbox Yes 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 No Decimal number e.g. 7.5 or 9 or 3
pi_fit_score_level Short textbox No Computed (High, Medium, Low) based on pi_fit_score ranges (>=8, >=4, else)
pi_reference_pattern_name Short textbox No Reference profile (e.g. Captain, Controller)
pi_reference_pattern_descr Short textbox No One sentence description ofreference profile
pi_person_page_url URL No Clickable link to PI Person Details
pi_descriptive_report_page_url URL No Clickable link to PI Report Options
pi_cognitive_score Short textbox Yes Score of the cognitive assessment.
pi_cognitive_percentile Short textbox Yes Percentile of the cognitive assessment.
pi_assessment_user_id Short textbox No ID of the Person in PI platform
pi_assessment_id_ba Short textbox No ID of the Behavioral assessment.
pi_assessment_id_ca Short textbox No ID of the Cognitive assessment.
pi_take_ba_assessment URL No URL sent to the candidate to take the Behavioral assessment. Use only for providing support to candidate.
pi_take_ca_assessment URL No URL sent to the candidate to take the Cognitive assessment. Use only for providing support to candidate
pi_refresh_ba Yes/No No Change to Yes and save to reload the Behavioral assessment and Job Fit data and associated reports
pi_refresh_ca Yes/No No Change to Yes and save to reload the Cognitive assessment data and report