What is the User Event API?
The User Event API allows you to import your users' security-related events or training activities from external sources and push them into your KnowBe4 console. Once imported, your custom event(s) will appear on the Events Timeline of affected users and may impact users' personal risk score. You can influence the risk score of your users by adding custom events that carry a positive, negative, or neutral risk value.
For full details about the User Event API, as well as sample requests, visit here. If you decide to use KnowBe4's User Event API, review the sections below to see how you can manage your API usage and how custom events can strengthen your security awareness training.
User Event API Management Console
The User Event API management console is a central location for you to monitor, create, and track the usage of your User Event API key(s). You can access the management console from the Account Settings page of your KnowBe4 account. The management console is divided into three main tabs: Call History, Stats, and API Key. For more information about each tab, see below:
The Call History tab will display a table of all of the API calls that were processed using your KnowBe4 account.
|Status ID||API Key||Events Created||Errors||Date Processed|
|A unique identifier generated for each API call.||The name of the API key used to make the API call.||The number of user events created as a result of the API call.||All of the errors received during the API call.||
The date and time the API request was processed.
Visit the Stats tab to monitor your Monthly and Annual API usage.
- Monthly Quota Your monthly API usage is displayed using a progress circle chart. The chart shows the percentage of API calls made in relation to the number of API calls allowed. You are allowed ten (10) calls per seat per day each month.
- Annual Quota Your annual API usage is displayed using a bar graph. The data is broken down by your Monthly Quota for each month over a twelve (12) month time period.
Use the API Key tab to create your API key(s). Your API key will be used to authenticate your KnowBe4 account when making an API call or request. To create an API key, follow the steps below:
- In the Name field, enter a unique name for your API key. If you plan on creating multiple API keys, we recommend using a meaningful name to best reflect the intended use of the key.
- Click the +Create API Key button.
Repeat the steps above to create as many API keys as you would like. Once created, your API key(s) will be listed in a table under the API Key tab.
|A unique identifier used to authenticate an API request associated with your KnowBe4 account. To copy the key string, click on the clipboard icon to the right.||The custom name you assigned to your API key when it was created.||Under the Actions column, you have the option to permanently delete an API key. To do this, click on the trash can icon.
Note: If you delete an API key, a record of the key's usage will still be available under the Call History tab.
- Reporting APIs and User Event APIs do not share an API key. Reporting API keys can be generated in your KnowBe4 Account Settings under the API section.
- A Platinum/Diamond subscription level is required for access to the User Event API Management Console.
User Event API Use Cases
Listed below are examples of how custom events can be used to strengthen your security awareness training. Visit here to learn how to create a Smart Group with custom events.
|Event Type||Example Events||Use Case|
|Enroll users in an event-specific Training Campaign. For example, you can assign a physical security training module from the ModStore to all users involved in a physical security event.|
Out of Office
|Enroll users in a custom Phishing Campaign based on employee information. For example, you can send an email template with a coupon to a local restaurant to all users with a birthday in the current month.|
|Third-Party Security||Non-simulated Phishing Incidents
Attempts to Visit Blocked Websites
|Track a user's involvement in a third-party security incident. You can use this information to select event-specific training content from the ModStore for enrollment and/or to influence a user's personal risk score.|
Training from another LMS
|Track a user's external training and accomplishments that contribute to their security awareness. This information can be used to influence a user's personal risk score.|