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:

EventName	URL	Case Management Only
CaseResultMonitoring	✔️	✔️
DVFCWeb	✔️	✔️
AlertRemediation	✔️	❌
BundleRemediation	✔️	❌

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:

Url	API Version
https://api.w2globaldata.com/callback-settings	2.6+

Request

The following properties pertain for creation of a callback setting.

Property Name	Type	Optional/Mandatory	Description
CallbackPreference	String	Mandatory*	Needs to be one of the following values: `Uri`, `Email` or `Both`.
CallbackUri	String	Optional**	Needs to be a valid URL.
CallbackEmail	String	Optional**	Needs to be a valid email address.
ServiceEventType	String	Mandatory	Needs to be one of the following Service Event Types: `CaseResultMonitoring` `DVFCWeb` `AlertRemediation` `BundleRemediation`

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": "your@email.com",
  "ServiceEventType": "AlertRemediation"
}

Example Response

{
    "CallbackPreference": "Uri",
    "CallbackUri": "https://<yourdomain>/callback",
    "CallbackEmail": "your@email.com",
    "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:

Url	API Version
https://api.w2globaldata.com/callback-settings	2.6+

Example Response

[
    {
        "CallbackPreference": "Uri",
        "CallbackUri": "https://<yourdomain>/callback",
        "ServiceEventType": "AlertRemediation"
    },
    {
        "CallbackPreference": "Both",
        "CallbackUri": "https://<yourdomain>/callback",
        "CallbackEmail": "your@email.com",
        "ServiceEventType": "BundleRemediation"
    },
    {
        "CallbackPreference": "Email",
        "CallbackEmail": "your@email.com",
        "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:

Url	API Version
https://api.w2globaldata.com/callback-settings/`ServiceEventType`	2.6+

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

ServiceEventType
CaseResultMonitoring
DVFCWeb
AlertRemediation
BundleRemediation

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:

Url	API Version
https://api.w2globaldata.com/callback-settings	2.6+

Request

The following properties pertain for creation of an session.

Property Name	Type	Optional/Mandatory	Description
CallbackPreference	String	Mandatory*	Needs to be one of the following values: `Uri`, `Email` or `Both`.
CallbackUri	String	Optional**	Needs to be a valid URL.
CallbackEmail	String	Optional**	Needs to be a valid email address.
ServiceEventType	String	Mandatory	Needs to be one of the following Service Event Types: `CaseResultMonitoring` `DVFCWeb` `AlertRemediation` `BundleRemediation`

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:

Url	API Version
https://api.w2globaldata.com/callback-settings/`ServiceEventType`	2.6+

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

ServiceEventType
CaseResultMonitoring
DVFCWeb
AlertRemediation
BundleRemediation