GET Notification Webhook Webhook Id Alerts

GET Notification Webhook Webhook Id Alerts

Retrieve webhook alerts.

Request
URI
GET
https://{api_host}/api/v2/notification/webhook/{webhookId}/alerts
COPY
Path Parameters
string
webhookId
Required

The UUID of the webhook

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved webhook alerts

Returns Array of object of type(s) application/json 
[
    {
        "id": "32ffeeb9-427e-475d-a983-a92a77c485c8",
        "enabled": true,
        "emailEnabled": true,
        "vcopsEnabled": false,
        "alertType": "RATE_BASED_WITH_GROUPS",
        "name": "Hello Alert 3",
        "hitCount": 5,
        "searchPeriod": 300000,
        "searchInterval": 60000,
        "emails": "[email protected]",
        "info": "This is an example of a rate based with groups alert",
        "vcopsResourceName": "",
        "vcopsCriticality": "none",
        "lastRanAt": 1497017941283,
        "lastRanAtString": "2017-06-09 18:19:01.283 GMT+04:00",
        "nextRunAt": 1497018241283,
        "nextRunAtString": "2017-06-09 18:24:01.283 GMT+04:00",
        "runCount": 79,
        "lastRunTime": 4,
        "totalRunTime": 55186,
        "lastHitTimestamp": 1497017922145,
        "lastHitTimestampString": "2017-06-09 18:18:42.145 GMT+04:00",
        "ownerUuid": "1f024658-8b93-4f45-ae59-4657f96a5450",
        "webhookEnabled": false,
        "autoClearAlertAfterTimeout": false,
        "chartQuery": "{\"query\":\"\",\"startTimeMillis\":1506417301511,\"endTimeMillis\":1506423141233,\"piqlFunctionGroups\":[{\"functions\":[{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false}],\"field\":null}],\"dateFilterPreset\":\"LAST_5_MINUTES\",\"shouldGroupByTime\":true,\"eventSortOrder\":\"DESC\",\"summarySortOrder\":\"DESC\",\"compareQueryOrderBy\":\"TREND\",\"compareQuerySortOrder\":\"DESC\",\"compareQueryOptions\":null,\"messageViewType\":\"EVENTS\",\"constraintToggle\":\"ALL\",\"piqlFunction\":{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false},\"piqlFunctionField\":null,\"fieldConstraints\":[{\"internalName\":\"ibadax3fpbpwm2lfnrsf643bl5stezk7onugc4tfmq000000\",\"operator\":\"CONTAINS\",\"value\":\"lang\"},{\"internalName\":\"ibadgns7mm4domrsgq4dkllgmvstcljrgfsteljygnrdoljsgbrtszbqgq3win3bg5sxqx3gnfwgkzc7onqv6zjsmvpw433oonugc4tfmrpwe6k7mfsg22lo\",\"operator\":\"CONTAINS\",\"value\":\"run\"}],\"supplementalConstraints\":[],\"group"
    },
    {
        "id": "94110e39-efd8-48ae-a767-2bf96afefc40",
        "enabled": true,
        "emailEnabled": true,
        "vcopsEnabled": false,
        "alertType": "NEW_EVENT_TYPE",
        "name": "Hello Alert 4",
        "hitCount": 0,
        "searchPeriod": 300000,
        "searchInterval": 300000,
        "emails": "[email protected]",
        "info": "This is an example of a new event type alert",
        "vcopsResourceName": "",
        "vcopsCriticality": "immediate",
        "lastRanAt": 1497017941391,
        "lastRanAtString": "2017-06-09 18:19:01.391 GMT+04:00",
        "nextRunAt": 1497018241391,
        "nextRunAtString": "2017-06-09 18:24:01.391 GMT+04:00",
        "runCount": 17,
        "lastRunTime": 1,
        "totalRunTime": 31,
        "lastHitTimestamp": 1497017922145,
        "lastHitTimestampString": "2017-06-09 18:18:42.145 GMT+04:00",
        "ownerUuid": "1f024658-8b93-4f45-ae59-4657f96a5450",
        "webhookEnabled": false,
        "autoClearAlertAfterTimeout": false,
        "chartQuery": "{\"query\":\"\",\"startTimeMillis\":1506417301511,\"endTimeMillis\":1506423141233,\"piqlFunctionGroups\":[{\"functions\":[{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false}],\"field\":null}],\"dateFilterPreset\":\"LAST_5_MINUTES\",\"shouldGroupByTime\":true,\"eventSortOrder\":\"DESC\",\"summarySortOrder\":\"DESC\",\"compareQueryOrderBy\":\"TREND\",\"compareQuerySortOrder\":\"DESC\",\"compareQueryOptions\":null,\"messageViewType\":\"EVENTS\",\"constraintToggle\":\"ALL\",\"piqlFunction\":{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false},\"piqlFunctionField\":null,\"fieldConstraints\":[{\"internalName\":\"ibadax3fpbpwm2lfnrsf643bl5stezk7onugc4tfmq000000\",\"operator\":\"CONTAINS\",\"value\":\"lang\"},{\"internalName\":\"ibadgns7mm4domrsgq4dkllgmvstcljrgfsteljygnrdoljsgbrtszbqgq3win3bg5sxqx3gnfwgkzc7onqv6zjsmvpw433oonugc4tfmrpwe6k7mfsg22lo\",\"operator\":\"CONTAINS\",\"value\":\"run\"}],\"supplementalConstraints\":[],\"group"
    },
    {
        "id": "df3cb390-1a0b-48ea-baa3-1116858127bc",
        "enabled": true,
        "emailEnabled": true,
        "vcopsEnabled": false,
        "alertType": "RATE_BASED",
        "name": "Hello Alert 2",
        "hitCount": 0,
        "searchPeriod": 300000,
        "searchInterval": 300000,
        "emails": "[email protected]",
        "info": "This is an example of an on any match alert",
        "vcopsResourceName": "",
        "vcopsCriticality": "none",
        "lastRanAtString": "2017-06-09 18:19:01.439 GMT+04:00",
        "nextRunAt": 1497018241439,
        "nextRunAtString": "2017-06-09 18:24:01.439 GMT+04:00",
        "runCount": 17,
        "lastRunTime": 1,
        "totalRunTime": 36,
        "lastHitTimestamp": 1497017922145,
        "lastHitTimestampString": "2017-06-09 18:18:42.145 GMT+04:00",
        "ownerUuid": "1f024658-8b93-4f45-ae59-4657f96a5450",
        "webhookEnabled": false,
        "autoClearAlertAfterTimeout": false,
        "chartQuery": "{\"query\":\"\",\"startTimeMillis\":1506417301511,\"endTimeMillis\":1506423141233,\"piqlFunctionGroups\":[{\"functions\":[{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false}],\"field\":null}],\"dateFilterPreset\":\"LAST_5_MINUTES\",\"shouldGroupByTime\":true,\"eventSortOrder\":\"DESC\",\"summarySortOrder\":\"DESC\",\"compareQueryOrderBy\":\"TREND\",\"compareQuerySortOrder\":\"DESC\",\"compareQueryOptions\":null,\"messageViewType\":\"EVENTS\",\"constraintToggle\":\"ALL\",\"piqlFunction\":{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false},\"piqlFunctionField\":null,\"fieldConstraints\":[{\"internalName\":\"ibadax3fpbpwm2lfnrsf643bl5stezk7onugc4tfmq000000\",\"operator\":\"CONTAINS\",\"value\":\"lang\"},{\"internalName\":\"ibadgns7mm4domrsgq4dkllgmvstcljrgfsteljygnrdoljsgbrtszbqgq3win3bg5sxqx3gnfwgkzc7onqv6zjsmvpw433oonugc4tfmrpwe6k7mfsg22lo\",\"operator\":\"CONTAINS\",\"value\":\"run\"}],\"supplementalConstraints\":[],\"group"
    },
    {
        "id": "fc7bfcac-200c-4840-b349-b885338f03d1",
        "enabled": true,
        "emailEnabled": true,
        "vcopsEnabled": true,
        "alertType": "RATE_BASED",
        "name": "Hello Alert",
        "hitCount": 2,
        "searchPeriod": 300000,
        "searchInterval": 60000,
        "emails": "[email protected], [email protected]",
        "info": "This is an example of a rate based alert",
        "vcopsResourceName": "local-li-wdc-li1-04",
        "vcopsCriticality": "immediate",
        "lastRanAt": 1497018241300,
        "lastRanAtString": "2017-06-09 18:24:01.300 GMT+04:00",
        "nextRunAt": 1497018541300,
        "nextRunAtString": "2017-06-09 18:29:01.300 GMT+04:00",
        "runCount": 86,
        "lastRunTime": 1,
        "totalRunTime": 1039,
        "lastHitTimestamp": 1497018235310,
        "lastHitTimestampString": "2017-06-09 18:23:55.310 GMT+04:00",
        "ownerUuid": "1f024658-8b93-4f45-ae59-4657f96a5450",
        "webhookEnabled": true,
        "webhookURLs": "http://example.com/webhook1 http://example.com/webhook2",
        "autoClearAlertAfterTimeout": false,
        "chartQuery": "{\"query\":\"\",\"startTimeMillis\":1506417301511,\"endTimeMillis\":1506423141233,\"piqlFunctionGroups\":[{\"functions\":[{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false}],\"field\":null}],\"dateFilterPreset\":\"LAST_5_MINUTES\",\"shouldGroupByTime\":true,\"eventSortOrder\":\"DESC\",\"summarySortOrder\":\"DESC\",\"compareQueryOrderBy\":\"TREND\",\"compareQuerySortOrder\":\"DESC\",\"compareQueryOptions\":null,\"messageViewType\":\"EVENTS\",\"constraintToggle\":\"ALL\",\"piqlFunction\":{\"label\":\"Count\",\"value\":\"COUNT\",\"requiresField\":false,\"numericOnly\":false},\"piqlFunctionField\":null,\"fieldConstraints\":[{\"internalName\":\"ibadax3fpbpwm2lfnrsf643bl5stezk7onugc4tfmq000000\",\"operator\":\"CONTAINS\",\"value\":\"lang\"},{\"internalName\":\"ibadgns7mm4domrsgq4dkllgmvstcljrgfsteljygnrdoljsgbrtszbqgq3win3bg5sxqx3gnfwgkzc7onqv6zjsmvpw433oonugc4tfmrpwe6k7mfsg22lo\",\"operator\":\"CONTAINS\",\"value\":\"run\"}],\"supplementalConstraints\":[],\"group"
    }
]

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/notification/webhook/{webhookId}/alerts
On This Page
Notification Operations
GET
GET Notification Channels
PUT
PUT Notification Channels
GET
GET Notification Email
PUT
PUT Notification Email
GET
GET Notification Webhook
PUT
PUT Notification Webhook
POST
POST Notification Webhook
GET
GET Notification Webhook Webhook Id
PUT
PUT Notification Webhook Webhook Id
DELETE
DELETE Notification Webhook Webhook Id
GET
GET Notification Webhook Webhook Id Alerts
GET
GET Notification Config Retention Threshold
PUT
PUT Notification Config Retention Threshold