ai.nightfall.scan.model.alert

Class WebhookAlert

java.lang.Object

ai.nightfall.scan.model.alert.WebhookAlert

public class WebhookAlert
extends Object

The WebhookAlert class contains the configuration required to allow clients to send a webhook event to an external URL when findings are detected. The URL provided must (1) use the HTTPS scheme, (2) have a route defined on the HTTP POST method, and (3) return a 200 status code upon receipt of the event.

In contrast to other platforms, when using the file scanning APIs, an alert is also sent to this webhook *even when there are no findings*.

Constructor Summary

Constructors

Constructor and Description
WebhookAlert(String address) Creates an instance of the WebhookAlert class with the provided URL.

Method Summary

Modifier and Type	Method and Description
String	getAddress() Returns the URL address to which alerts should be delivered.
void	setAddress(String address) Sets the URL address to which alerts should be delivered.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebhookAlert

public WebhookAlert(String address)

Creates an instance of the WebhookAlert class with the provided URL.

Parameters:

address - a URL address

Method Detail

getAddress

public String getAddress()

Returns the URL address to which alerts should be delivered.

Returns:

the URL address

setAddress

public void setAddress(String address)

Sets the URL address to which alerts should be delivered.

Parameters:

address - the URL address

toString

public String toString()

Overrides:

toString in class Object