Getting Started with PI Integrations

Please read the technical Overview or the less-technical Integration Overview for more details on selecting the best option for integrating The Predictive Index with other software: REST API or Open Invitation Links.

After selecting your preferred option, you can follow the below steps to get you started on your way to integrating with the PI software:

For REST API:

  1. Read our knowledgebase article: API Integration Overview
  2. Your organization's PI account must have API Access turned on. Contact your own PI Consultant or The Predictive Index Integrations Team at integrations@predictiveindex.comto ensure your account has API Access turned on.
  3. To create an API Key for authenticating your method calls follow these steps: Generating an API Key.
  4. If desired, you may request a test account (known as a Sandbox) which can be used to develop the integration by contacting The Predictive Index Integrations Team at integrations@predictiveindex.com and asking for a Sandbox Account.
  5. Whoever will be doing the development work should review the API Guide to understand the REST API strategy, study the detailed examples in Integration Best Practices, learn about Webhooks, and use the API Reference to gain a more in-depth understanding of the requests and response payload structure, including testing specific method calls
  6. Build your integration!

If using Open Invitation:

  1. Any subscription level provides access to create an Open Invitation.
  2. Review the article How to Administer an Assessment Using an Open Invitation Link
  3. Setup your Open Invitation links as desired within the PI software
  4. Optionally consider developing a partial REST API integration by setting up a listener that uses the Default Assessment Status Webhook URL (found in the PI software > Administration > General Settings) to act upon any completed assessments in some automated way.  
  5. Once an Open Invitation link is created you can deliver the link to assessment takers in any way you desire. For example, after a candidate applies in your ATS...

  • Show the link on a "Thank You for Your Application" page
  • Include the link in an email sent by the ATS to the newly applied candidate