Collect events

https://api.alert.alertinghub.co.uk/api/json/collectevents

For all notification systems it is critical that, from the point a message is sent out, you can monitor the delivery status of each message to every designated recipient. With Alerting Hub this data can be gleaned in two ways – collection or callback driven.

If your API key is setup for collection (also know as polled) or you have specified a particular alert to use the “poll” method of notification then this API will return pending results or events to you.

Json sample

{
    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "alertId": "all",
    "options": {
        "maximumItemsToReturn": 50
    }
}
Back to API guide

Collecting events

Parameter RequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
alertIdMandatoryNoneAlertId previously returned by /sendalert or /sendstoredalert OR you can specify 'all' to return all events on all suitable alerts.
options
maximumItemsToReturnOptional1Maximum number of events/items to return
returnNumRemainingOptionalFalseIf true will return (in numEventsRemaining) the number of remaining events for collection.

Response

Parameter Description
successOne of “true”, “false”. If false then failureReason should also be returned
eventsArray of events same format as callback return
clientRefFrom the original alert
alertIdFrom the original alert
typeOne of "call","sms", "email","inboundCall","recipientList" or "alert". The type of event reported on.
eventActual event, details not included here
alerteesList of alertees
replyAdditional reply info if pertinent
replyEncodingOne of "base64" or "utf8". This is the encoding of the reply
Back to API guide