Configure the Webhook integration
Configure a Webhook endpoint to push Nozomi Networks data to an HTTP or HTTPS endpoint.
Before you begin
Make sure that you have:
- The target webhook uniform resource locator (URL)
- Authentication credentials for the endpoint (Bearer token, or username and password for Basic authentication)
About this task
The following parameters are required.
| Parameter | Description |
|---|---|
| To URI | The webhook URL, for example
https://myapp.example.com/nozomi-hook. |
| Entity | One of: alerts, nodes,
assets, asset_cves. |
Select one of the following authentication methods.
| Authentication method | Description |
|---|---|
| Bearer token | Sends the token in the
Authorization: Bearer <token> header. |
| Basic authentication | Uses a username and password for Basic authentication. |
The following parameters are optional.
| Parameter | Description | Default |
|---|---|---|
description |
A description for the endpoint configuration. | None |
format |
Request body format: json, csv, or
ndjson. |
json |
query_filter |
An extra query filter to limit the records sent by the integration. | None |
send_updates |
Re-sends updated records when supported by the selected entity type. | false |
page_count |
Number of records per chunk. | 300 |
Procedure
-
In the top navigation bar, select The administration page opens.
-
In the Settings section, select Data
integration.
The Data integration page opens.
-
Select Add.
A dialog shows.
- From the Choose a configuration dropdown, select Webhook.
- Set Endpoint Configured as to Webhook.
- Enter a value in Description.
- Enter the target URL in To URI.
-
Select the authentication method and enter the required credentials:
Method Action Bearer token Enter the token value. Basic authentication Enter a username and password. -
Select the output Format:
- JSON
- CSV
- NDJSON
-
Select one Entity type:
- Enable sending Alerts
- Enable sending Nodes
- Enable sending Asset information
- Enable sending Asset CVEs
Note:Only one entity type can be enabled per Webhook endpoint. Create a separate endpoint for each additional entity type. - Optional: Select Send updates to re-send updated records when the selected entity type supports it.
- Optional: Enter a Query filter to limit the records sent.
- Select Edit Endpoint to save the configuration.
Results
The Webhook endpoint is saved and begins pushing data to the configured URL on the next run.