Note
Only KnowBe4 customers holding Platinum and Diamond accounts can use the API feature.
You can use your KnowBe4 account alongside HighGround to retrieve your Phishing Training data. This data can then be used to drive your Cyber KPI's. In order to synchronise this data to your HighGround account, you will need to connect to KnowBe4's API by first generating API credentials, and then integrate the tool via the Integrations module.
The following process is reasonably technical, so please have a member of your IT team complete this if you do not have any prior experience with API's.
Please follow the steps below to generate API credentials for KnowBe4 first, before moving onto our guide on How to Integrate a tool with your HighGround account.
STEP 1: Login to KnowBe4
Login to your KnowBe4 account.
STEP 2: Choose Account
If you are a Managed Service Provider (MSP) or IT company catering for multiple clients/accounts, you will need to first select the client that you would like to generate the API credentials for. Please click on the tab below to learn how to do this.
If you are not an MSP/IT management provider, and you are generating the API credentials for your own organisation, please skip this step and move on to Step 2.
Select a client/account that you manage
Select a client/account that you manage
From the main menu, select Accounts:
You should now see a list of the accounts that you manage. Click into the account you would like to generate the API credentials for.
Next, in the Account Admin row, click View as Admin:
You should now be able to view and use that account as an administrator.
Please continue on with the rest of the guide.
STEP 3: Go to Account Settings
Whilst logged into your account, look to the top-righthand corner where you will see your account email address.
Click on this to expand the drop-down menu like below, and select Account Settings.:
STEP 4: Go to Account Integrations, API
Once in Account Settings, click on the Account Integrations option from the menu, then click API from the drop-down menu:
STEP 5: Generate API Token
Under Reporting API, tick the box next to the statement 'Enable Reporting API Access':
This will generate an API Token (or 'API key') that you will need in the next step:
Please click on the box containing the API token to copy it to your clipboard.
STEP 6: Integrate KnowBe4 to your HighGround Account
You can now use the API token retrieved in the previous step to integrate the tool to your HighGround account.
To do so, you will need to go to the Integrations area of your HighGround account, and find the KnowBe4 tool under the Phishing Training technology. Clicking on 'Connect Tool' will open a window for you to enter your API Token.
In addition, you will need to enter one of the following URL's:
For US Organisations: https://us.api.knowbe4.com
For European Organisations: https://eu.api.knowbe4.com
I'm not located in the EU or US - which URL do I use?
I'm not located in the EU or US - which URL do I use?
If you reside outside of the EU and US, you can tell which of those locations your KnowBe4 console is hosted at by checking the URL you use to login.
If you use training.knowbe4.com to login, your account is hosted on the US server, so use the URL - https://us.api.knowbe4.com
If you use eu.knowbe4.com to login, your account is hosted on the EU server, so use the URL - https://eu.api.knowbe4.com/
After you've entered the URL, enter the API Token you retrieved in the previous step into the API Key field:
Continue in the integration window pictured above to complete the process of connecting your KnowBe4 account.
If you are unsure of how to complete the integration, you can look at our guide on How to Integrate a tool with your HighGround account.