Open API

Managing open API settings

The Open API page allows you to modify settings associated with PI’s API. This includes the ability to enable webhooks, set a default webhook URL for your organization, and create API keys.

How to access PI’s open API settings

  1. Log in to the PI software. 
  2. Click the gear icon () in the top-right of the navigation bar. 
  1. You will land on the People tab within Administration.
  2. Select the Integrations tab.
  1. Select Open API on the left-hand side.

Note: Open API settings are only available to organization admins.

Enabling webhooks

Toggle the “Allow Webhooks” setting, and you’ll enable the ability to receive event data whenever a PI Behavioral or Cognitive Assessment is completed.

This toggle applies to your company’s “default webhook,” as well as to any “single webhooks” you may have. (Your default webhook is a company-wide URL that is defined here on the Open API screen, whereas single webhooks are individual and defined at the creation of a unique PI assessment.)

For more on webhooks, visit our developer documentation site.

Setting up a default webhook

Create a default webhook URL, and you’ll receive event data whenever a PI assessment sent by your organization is completed.

To start receiving event data:

  1. Enter your desired webhook URL (example: https://integration.somedomain.com/listeners/predictiveindex/assessmentstatus).

Note: The URL you enter should be the web address of a listener service belonging to the relevant integration. For more on webhooks, listeners, and best practices, visit our developer documentation site.

  1. Click the “Save” button to confirm.
  1. Make sure the “Allow Webhooks” setting is toggled on.
  1. Your default webhook has been created and is enabled to receive event data.

How to add a new API key

You can only generate an API key if you have an organization admin to associate that key with. 

To create a key:

  1. Click the “Add API key” button.
  1. Select an organization admin from the dropdown options.
  1. Click “Generate API key” to confirm.
  1. An API key will be created for the selected organization admin.
  1. (Optional) Click the ellipsis button () next to the key to copy it to your clipboard or delete it.

Note: An organization admin can only be associated with a single API key.

FAQs

My webhooks don’t seem to be receiving data. Why?
To troubleshoot, make sure you’ve enabled webhooks and that the webhook you’re referring to is the correct URL. If you’re not a developer, we suggest you reach out to a member of your IT, web development, or engineering team.
I’m a developer. Where can I get additional documentation on PI’s API?
For detailed documentation on our API, webhooks, calls, and more, visit our technical documentation site.

If you have additional questions, please submit a case with our support team.
I don’t see the Open API page. Why?
The Open API page is only available to organization admins.
I see the Open API page but cannot access it. Why?
The Open API page is a pro feature. For questions or support, please contact your PI consultant.

Do you still need support? Contact us here.

Was this page helpful? Spot a typo or inaccuracy? Let us know.