Send stored alert

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

The Alerting Hub API allows you to save specific alerts to the system, which can either be sent immediately or at a later time using the schedule as described below. If you use a schedule you can also specify a repeat pattern for the alert.

Json sample

{
    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "storeId": "98898333-db82-44cd-aeef-38844bbd0c6e" 
}

{

Back to API guide

Sending stored alerts

Parameter		Requirement	Default	Description
version		Mandatory	None	See API guide
apiKey		Mandatory	None	See API guide
storeId		Mandatory	None	The unique id of a stored alert
options
	schedule	Optional	None	See API guide

Response

Parameter		Description
If no schedule requested
success		One of “true”, “false”. If false then failureReason should also be returned
clientRef		From the request
alertRef		Internally generated alertId relating to all alerts[] in /sendalert
emailSubjectRef		If at least one alert[] was of type "email" this gives the subject reference on all emails within this alert
alerts
	alertType	From request
	tag	From request
	success	One of “true”, “false”. If false then failureReason should also be returned
	requestedCount	Number of recipients originally asked for
	sentCount	Actual number of recipients processed
	remainingCapacity	Capacity remaining for the given type
If schedule requested

success		One of “true”, “false”. If false then failureReason should also be returned
scheduleId		Unique schedule reference

Back to API guide