PI's Open API page allows you to manage open API settings for integrations built by one of our approved vendors, such as Joynd or Flexspring.
These settings include the ability to enable webhooks, set a default webhook URL for your organization, and create API keys.
Please note: The Predictive Index's open API will only function if your organization has been granted API access by our support team. If you intend to use our API, please submit a support ticket.
How to access PI’s open API settings
Log in to the PI software.
Click the gear icon (
) in the top-right of the navigation bar.
You will land on the People tab within Administration.
Select the Integrations tab.
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.)
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:
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.
Click the “Save” button to confirm.
Make sure the “Allow Webhooks” setting is toggled on.
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:
Click the “Add API key” button.
Select an organization admin from the dropdown options. (Note: An organization admin can only be associated with a single API key.)
Click “Generate API key” to confirm.
An API key will be created for the selected organization admin.
(Optional) Click the ellipsis button (
) next to the key to copy it to your clipboard or delete it.
Note: To use API keys within your integration, your developers will need to set this value as within the HTTP header request using the "api-key" variable name.
FAQs
My webhooks don't seem to be receiving data. Why?
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.
Please note: The Predictive Index's open API will only function if your organization has been granted API access by our support team. To verify whether your organization has API access, please submit a support ticket.
I'm a developer. Where can I get additional information about PI's API?
I'm a developer. Where can I get additional information about PI's API?
For more information about our API, please submit a case with our support team.
I don't see the Open API page. Why?
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?
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.