Webhooks in Your KMSAT Console

In your KMSAT console, you can create webhooks to send real-time phishing and training data to the other applications you use. Webhooks create a connection to send data from one application to another application through a payload. You can configure webhooks to perform specific actions when they receive data. For example, you could create a KMSAT webhook to send your users’ phishing event data to a data analysis platform such as Splunk so you can monitor that data from Splunk.

Jump to:

Creating Webhooks in Your KMSAT Console

Webhook Retry Policy

Webhook Deactivation Policy

Creating Webhooks in Your KMSAT Console

To create a webhook, follow the steps below:

1. From your KMSAT admin account, click your email address at the top-right corner of the page and select Account Settings.
2. Navigate to Account Integrations > Webhooks.
3. Click the + Create button.
   
4. Fill out the fields in the Create Webhook section. For more information, see the screenshot and list below:
   1. Name: Enter a name that describes the purpose of your webhook.
   2. URL: Enter the URL that you would like to send data to. For example, if you are creating a webhook for Slack, you could enter the URL for a specific Slack channel.
   3. Enable Webhook Failure Notifications: Select this check box to enable webhook failure notifications. Recipients will receive an email notification if the webhook receives 50 percent of the allowed failed responses in an hour. A second notification will be sent if the webhook exceeds the allowed number of failed responses and is deactivated. To learn more about how the allowed number of failed responses, see the Webhook Deactivation Policy section below.
   4. Authentication: If you would like to use authentication to authorize the webhook, select an authentication method. Once you select an authentication method, additional fields will display for you to enter information about it.
   5. Custom Data: To add custom data to your webhook’s payload, click the plus sign icon. Then, fill out the Key and Value fields. For example, if your application requires "{ "System" : "KnowBe4" }" in the payload to receive data, you could enter "System" and "KnowBe4".
   6. Custom Header: If you would like to add a custom header, click the plus sign icon. Then, fill out the Key and Value fields. For example, if your firewall requires the "{ "Header" : "KnowBe4" }” header to allow data to pass through, you could enter "Header" and "KnowBe4".
   7. Status: Select the status of your webhook. To use the webhook after it is created, select Active.
   8. Events: Select the events to send to your webhook. To select all Phishing Events, Training Events, or General Events, select the corresponding check boxes. To select specific events, click the drop-down arrow next to an option and then select the check boxes next to the events.

Back to top

Webhook Retry Policy

If a webhook request fails, KMSAT will retry the failed webhook up to three additional times. These retries will have a 15-minute delay between each request.

Back to top

Webhook Deactivation Policy

If a webhook connection receives more than 1,000 failed responses in an hour, the webhook will be deactivated. We recommend verifying that the webhook is configured correctly and that the recipient server can receive webhook requests. You can then set the webhook’s status back to Active in your Account Settings.

Back to top