Callback Settings ​

To be able to consume our webhooks, you can use the following endpoints specified here. You'll be able to set the URL and Email address for events in our system.

Currently available events:

Create ​

The section below describes how to create a callback setting.

How to use ​

To call the endpoint you will need to perform a HTTP POST request to the URL:

Request ​

The following properties pertain for creation of a callback setting.

Notes ​

CallbackUri and CallbackEmail are optional, however they need to be provided depending on the specified CallbackPreference. For example if Uri is specified as the CallbackPreference, CallbackUri needs to be provided.

Example Request ​

{
  "CallbackPreference": "Uri",
  "CallbackUri": "https://<yourdomain>/callback",
  "CallbackEmail": "[email protected]",
  "ServiceEventType": "AlertRemediation"
}

Example Response ​

{
    "CallbackPreference": "Uri",
    "CallbackUri": "https://<yourdomain>/callback",
    "CallbackEmail": "[email protected]",
    "ServiceEventType": "AlertRemediation"
}

Retrieve All ​

The section below describes how to retrieve all callback settings.

How to use ​

To call the endpoint you will need to perform a HTTP GET request to the URL:

Example Response ​

[
    {
        "CallbackPreference": "Uri",
        "CallbackUri": "https://<yourdomain>/callback",
        "ServiceEventType": "AlertRemediation"
    },
    {
        "CallbackPreference": "Both",
        "CallbackUri": "https://<yourdomain>/callback",
        "CallbackEmail": "[email protected]",
        "ServiceEventType": "BundleRemediation"
    },
    {
        "CallbackPreference": "Email",
        "CallbackEmail": "[email protected]",
        "ServiceEventType": "DVFCWeb"
    }
]

Retrieve Single ​

The section below describes how to retrieve a callback setting.

How to use ​

To call the endpoint you will need to perform a HTTP GET request to the URL:

One of the following ServiceEventType needs to be specified in the URL:

Example Response ​

{
    "CallbackPreference": "Uri",
    "CallbackUri": "https://<yourdomain>/callback",
    "ServiceEventType": "AlertRemediation"
}

Update ​

The section below describes how to update a callback setting.

How to use ​

To call the endpoint you will need to perform a HTTP PATCH request to the URL:

Request ​

The following properties pertain for creation of an session.

Notes ​

CallbackUri and CallbackEmail are optional, however they need to be provided depending on the specified CallbackPreference. For example if Uri is specified as the CallbackPreference, CallbackUri needs to be provided.

Example Request ​

{
  "CallbackPreference": "Uri",
  "CallbackUri": "https://<yourdomain>/callback",
  "ServiceEventType": "AlertRemediation"
}

Example Response ​

{
    "CallbackPreference": "Uri",
    "CallbackUri": "https://<yourdomain>/callback",
    "ServiceEventType": "AlertRemediation"
}

Delete ​

The section below describes how to delete a callback setting.

How to use ​

To call the endpoint you will need to perform a HTTP DELETE request to the URL:

One of the following ServiceEventType needs to be specified in the URL: