CloudRadial AutomationAI has two KnowBe4 extensions. KnowBe4 reads security-awareness data: account and user risk scores, users and groups, simulated-phishing results, and training campaigns and enrollments. KnowBe4 User Events pushes custom user events into KnowBe4 to feed risk scoring and SecurityCoach. This article explains which extension to install, the separate API keys each one needs, which tools require approval, and the skills that ship with them. It is for workspace users who build automations (Admin or Owner Role).
- Choosing an Extension
- What the Extensions Cover
- Creating the API Keys
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With KnowBe4 Data
Choosing an Extension
The two extensions call two different KnowBe4 APIs, each with its own regional host and its own API key. Install the one that matches what you want to automate, or both:
| Extension | Install it to | KnowBe4 API |
| KnowBe4 | Report on risk, phishing tests, and training completion. Every tool is read-only. | Reporting API |
| KnowBe4 User Events | Record custom user events, such as a risky action or a positive security behavior, and manage the event types they use. Writes require approval. | User Event API |
The extensions don't share secrets. If you install both, set up both sets of credentials described below. Install them from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
What the Extensions Cover
The KnowBe4 extension provides 14 tools:
| Area | What you can automate |
| Account risk (1 tool) | Read the account-level risk summary and account details |
| Users (3 tools) | List users, optionally filtered by group or search term and sorted by risk score; read one user's profile and risk data; and list users with their risk scores to find one user or the highest-risk users |
| Groups (3 tools) | List groups, read one group, and list a group's members |
| Phishing (4 tools) | List simulated-phishing campaigns and security tests, read one security test in detail, and list each recipient's outcome on a test |
| Training (3 tools) | List training campaigns, read one campaign, and list enrollments and their completion status, filtered by campaign, user, or store purchase |
The KnowBe4 User Events extension provides 12 tools:
| Area | What you can automate |
| User events (5 tools) | List and read user events, record one event, create or delete events in bulk, and delete an event |
| Event types (5 tools) | List and read event types, and create, update, or delete one |
| Request status (2 tools) | List the processing statuses of submitted event requests, or read one |
A user event ties a user, identified by email address, to an event type. It can also carry an external id, a source, the date it occurred, and extra metadata. An event type has a name, a description, and a risk level.
Creating the API Keys
Each extension needs its own key. Don't reuse the Reporting API key for User Events.
- KnowBe4 (Reporting API): in the KSAT console, click your email address at the top right and select Account Settings, then go to Account Integrations > API. Under Reporting API, turn on Enable Report API Access, click Reporting API, then click + Create New API Token. Copy the token from the pop-up before you close it; KnowBe4 doesn't show it again.
- KnowBe4 User Events (User Event API): in the same Account Integrations > API section, click User Event API to open the User Event API Management Console. On the API Key tab, enter a name and click Create API Key, then copy the token from the pop-up before you close it. The console requires a Platinum, Diamond, or SAT Advanced subscription.
Providing the Credentials to Your Runner
Store the secrets for each extension you install in your runner's Key Vault with these exact names:
| Extension | Secret | Value |
| KnowBe4 | KnowBe4-ApiUrl |
The Reporting API host for your KnowBe4 console's region, host only: https://us.api.knowbe4.com (US) or https://eu.api.knowbe4.com (EU) |
| KnowBe4 | KnowBe4-ApiKey |
The Reporting API key |
| KnowBe4 User Events | KnowBe4-EventsApiUrl |
The User Event API host for your region, host only: https://api.events.knowbe4.com (US), https://api-eu.events.knowbe4.com (EU), https://api-ca.events.knowbe4.com (Canada), https://api-uk.events.knowbe4.com (UK), or https://api-de.events.knowbe4.com (Germany) |
| KnowBe4 User Events | KnowBe4-EventsApiKey |
The User Event API key |
Store each host with nothing after it: no /v1, no /api, and no trailing path. The extensions add the correct paths themselves. Store each key exactly as KnowBe4 issued it; the extensions send it as a Bearer token for you. For how to add secrets, see Accessing and updating your runner's Key Vault. If you keep a separate KnowBe4 account per client, see Managing companies and per-company credentials.
The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground for your KnowBe4 account risk summary, or to list your event types, to confirm each connection works.
Reads and Approval-Gated Changes
The KnowBe4 extension is read-only. The Reporting API offers reads only, so none of its 14 tools change anything in KnowBe4 and none require approval. It can't enroll a user in training; do that in the KnowBe4 console.
In KnowBe4 User Events, 6 of the 12 tools are read-only. The other 6 are approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Record a user event; create or delete events in bulk; delete an event; create, update, or delete an event type |
| Read-only | List and read user events; list and read event types; list and read request statuses |
Events you record feed each user's risk score, so check the user and the event type before you approve.
Skills
The KnowBe4 extension ships five skills, all read-only:
| Skill | Use it to |
| Browse KnowBe4 Users and Groups | List users, optionally filtered or sorted by risk, read a single user, list groups, read a group, or list a group's members |
| Report on KnowBe4 Phishing Campaigns and Tests | List phishing campaigns and security test results, read one security test, or list the recipients of a test |
| Report on KnowBe4 Training Campaigns and Enrollments | List training campaigns, read one campaign, or list enrollments by campaign or user, for example to find active users who have not completed required training |
| Review KnowBe4 Account Risk | Review overall account risk and identify the highest-risk users |
| Review a KnowBe4 User's Risk | Review one user's risk score, profile, simulated-phishing outcomes, and training enrollment and completion status |
The KnowBe4 User Events extension ships three skills:
| Skill | Use it to |
| Push Custom User Events to KnowBe4 | Record a custom user event, such as a risky action or a positive security behavior, so it feeds risk scoring. Posting and deleting events wait for approval. |
| Manage KnowBe4 User Event Types | Define, review, update, or remove custom event types. Creates, updates, and deletes wait for approval. |
| Check KnowBe4 Event Request Status | Check the processing status of submitted event requests. Read-only. |
Tips for Working With KnowBe4 Data
- The Reporting API can't filter users by email. To find one person, the agent lists users and matches the email address itself, so give the full address.
- List tools in both extensions return the complete result set in one call, so you don't need to ask for more pages
- Create or confirm the event type before you record events that use it. The agent resolves the event type first.
- Use the request status tools to confirm KnowBe4 processed events you submitted
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.