Managing open API settings

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.

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. 

3. You will land on the People tab within Administration.
4. Select the Integrations tab.

5. 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:

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.

2. Click the “Save” button to confirm.

3. Make sure the “Allow Webhooks” setting is toggled on.

4. 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.

2. Select an organization admin from the dropdown options. (Note: An organization admin can only be associated with a single API key.)

3. Click “Generate API key” to confirm.

4. An API key will be created for the selected organization admin.

5. (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

---