Sending Alerts
The Konexus platform allows users to customize many aspects of their Alerting experience. In order to support the extreme level of customization, you must first ask for the default settings for an alert.
The below examples show the requests necessary to Send an Alert through the platform. For a full review of Alerting capabilities, see the Alerting API Specification.
1. Retrieve the default Alert Settings for the authorized Sender
POST - /v2/alerts/defaults
{
"alertType": "Default"
}
{
"alertType": "Default"
}
{ "item": { "fields": [ { "name": "template", "required": false, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "priority", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "subject", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "message", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "recipients", "required": true, "invisible": false, "readonly": false, "systemRequired": true, "autofill": false } ], "alertType": "Default", "channels": { "email": { "requestConfirmation": false, "send": true }, "fax": { "send": false }, "push": { "send": true }, "textMessage": { "primary": true, "secondary": true, "deliveryMethod": "Sms", "send": true }, "voice": { "cellPhone": false, "businessPhone": false, "homePhone": false, "useOptOut": false, "send": false }, "etn": { "publicUsers": false, "importUsers": false, "directoryUsers": false, "send": false }, "facebook": { "accountIds": [], "pageIds": [], "send": false }, "twitter": { "accountIds": [], "send": false }, "nextdoor": { "accounts": [], "send": false }, "mobileBroadcast": { "send": false }, "myAlertsApp": { "send": false }, "microsoftTeams": { "send": true } }, "clientContext": { "isResend": false, "platform": "Web", "clientId": "io.alertsense.dev.apps", "clientName": "Balsa", "clientVersion": "1.47.0.2493", "deviceId": "browser7-4036-55de-ebdb-7246e1e66894" }, "formType": "Quick", "facilities": { "facilities": [], "areas": [] }, "message": { "priority": "NonEmergency", "basic": { "subject": "Test Alert", "message": "" }, "files": [], "language": "en-us", "translate": true }, "recipients": { "uniqueMyAlertsAppCount": 0, "uniqueEtnCount": 0, "uniqueGroupCount": 0, "uniqueContactCount": 0, "selectedContactCount": 0, "selectedGroupCount": 0, "groupIds": [], "mandatoryGroupIds": [], "contactIds": [], "groups": [], "contacts": [], "directories": [], "searchFilters": [] }, "schedule": { "scheduled": false, "duration": 120, "type": "Hickory" }, "sender": { "id": 0, "displayName": "Alton Ballard", "email": "alton.ballard@konexus.com", "callerId": "8883072013" }, "hidden": false, "weatherAlert": false, "requestConfirmation": false, "relatedAlertActions": { "disableReplyAll": false } }, "status": { "isSuccess": true, "errorCode": "None", "validationFailures": [], "messages": [] }, "hasErrors": false, "isValid": true } ```
2. Modify the Alert Settings
In this example, we're going to modify the message. Take the item from the default Alert Settings (above) and customize it like below.
{
// Excluded for brevity.
"message": {
"basic": {
"subject": "Example Subject",
"message": "Example Message",
"messageBody": "<h1>Example Message</h1>"
}
},
"recipients": {
"groupIds": [],
"contactIds": []
},
// Excluded for brevity.
}
3. Preview the Alert
POST - /v2/alerts/preview
{
"settings": {
"alertType": "Default",
"channels": {
"email": {
"requestConfirmation": false,
"send": true
},
"fax": {
"send": false
},
"push": {
"send": true
},
"textMessage": {
"primary": true,
"secondary": true,
"deliveryMethod": "Sms",
"send": true
},
"voice": {
"cellPhone": false,
"businessPhone": false,
"homePhone": false,
"useOptOut": false,
"send": false
},
"etn": {
"publicUsers": false,
"importUsers": false,
"directoryUsers": false,
"send": false
},
"facebook": {
"accountIds": [],
"pageIds": [],
"send": false
},
"twitter": {
"accountIds": [],
"send": false
},
"nextdoor": {
"accounts": [],
"send": false
},
"mobileBroadcast": {
"send": false
},
"myAlertsApp": {
"send": false
},
"microsoftTeams": {
"send": true
}
},
"clientContext": {
"isResend": false,
"platform": "Web",
"clientId": "io.alertsense.dev.apps",
"clientName": "Balsa",
"clientVersion": "1.47.0.2493",
"deviceId": "browser7-4036-55de-ebdb-7246e1e66894"
},
"formType": "Quick",
"brandId": 234234,
"facilities": {
"facilities": [],
"areas": []
},
"location": {
"facilities": [],
"areas": []
},
"message": {
"priority": "NonEmergency",
"basic": {
"subject": "Example Subject",
"message": "Example Message",
"messageBody": "Example Message"
},
"files": [],
"language": "en-us",
"translate": true
},
"recipients": {
"uniqueMyAlertsAppCount": 0,
"uniqueEtnCount": 0,
"uniqueGroupCount": 1,
"uniqueContactCount": 3,
"selectedContactCount": 2,
"selectedGroupCount": 1,
"groupIds": [
556677
],
"mandatoryGroupIds": [],
"contactIds": [
12345,
67890
],
"groups": [],
"contacts": [],
"directories": [],
"distributionListId": "2b89d861-b26a-404f-a341-ca94645c3efg",
"searchFilters": []
},
"schedule": {
"scheduled": false,
"duration": 120,
"type": "Balsa"
},
"sender": {
"id": 0,
"asset": {
"id": "9c2d6b29658947058a2ebcdf35ded4b4",
"name": "Corporate Office"
},
"displayName": "Alton Ballard",
"email": "alton.ballard@konexus.com"
},
"hidden": false,
"publicAlert": false,
"weatherAlert": false,
"requestConfirmation": false,
"relatedAlertActions": {
"disableReplyAll": false
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
{
"item": {
"alertType": "Default",
"channels": {
"email": {
"requestConfirmation": false,
"send": true
},
"fax": {
"send": false
},
"push": {
"send": true
},
"textMessage": {
"primary": true,
"secondary": true,
"deliveryMethod": "Sms",
"send": true
},
"voice": {
"cellPhone": false,
"businessPhone": false,
"homePhone": false,
"useOptOut": false,
"send": false
},
"etn": {
"publicUsers": false,
"importUsers": false,
"directoryUsers": false,
"send": false
},
"facebook": {
"accountIds": [],
"pageIds": [],
"send": false
},
"twitter": {
"accountIds": [],
"send": false
},
"nextdoor": {
"accounts": [],
"send": false
},
"mobileBroadcast": {
"send": false
},
"myAlertsApp": {
"send": false
},
"microsoftTeams": {
"send": true
}
},
"clientContext": {
"isResend": false,
"platform": "Web",
"clientId": "io.alertsense.dev.apps",
"clientName": "Balsa",
"clientVersion": "1.47.0.2493",
"deviceId": "browser7-4036-55de-ebdb-7246e1e66894"
},
"formType": "Quick",
"brandId": 234234,
"facilities": {
"facilities": [],
"areas": []
},
"location": {
"facilities": [],
"areas": []
},
"message": {
"priority": "NonEmergency",
"basic": {
"subject": "Example Subject",
"message": "Example Message",
"messageBody": "Example Message"
},
"files": [],
"language": "en-us",
"translate": true
},
"recipients": {
"uniqueMyAlertsAppCount": 0,
"uniqueEtnCount": 0,
"uniqueGroupCount": 1,
"uniqueContactCount": 3,
"selectedContactCount": 2,
"selectedGroupCount": 1,
"groupIds": [
556677
],
"mandatoryGroupIds": [],
"contactIds": [
12345,
67890
],
"groups": [],
"contacts": [],
"directories": [],
"distributionListId": "2b89d861-b26a-404f-a341-ca94645c3efg",
"searchFilters": []
},
"schedule": {
"scheduled": false,
"duration": 120,
"type": "Balsa"
},
"sender": {
"id": 0,
"asset": {
"id": "9c2d6b29658947058a2ebcdf35ded4b4",
"name": "Corporate Office"
},
"displayName": "Alton Ballard",
"email": "alton.ballard@konexus.com"
},
"hidden": false,
"publicAlert": false,
"weatherAlert": false,
"requestConfirmation": false,
"relatedAlertActions": {
"disableReplyAll": false
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
4. Send the Alert
POST - /v2/alerts/alerts
{
"settings": {
"alertType": "Default",
"channels": {
"email": {
"requestConfirmation": false,
"send": true
},
"fax": {
"send": false
},
"push": {
"send": true
},
"textMessage": {
"primary": true,
"secondary": true,
"deliveryMethod": "Sms",
"send": true
},
"voice": {
"cellPhone": false,
"businessPhone": false,
"homePhone": false,
"useOptOut": false,
"send": false
},
"etn": {
"publicUsers": false,
"importUsers": false,
"directoryUsers": false,
"send": false
},
"facebook": {
"accountIds": [],
"pageIds": [],
"send": false
},
"twitter": {
"accountIds": [],
"send": false
},
"nextdoor": {
"accounts": [],
"send": false
},
"mobileBroadcast": {
"send": false
},
"myAlertsApp": {
"send": false
},
"microsoftTeams": {
"send": true
}
},
"clientContext": {
"isResend": false,
"platform": "Web",
"clientId": "io.alertsense.dev.apps",
"clientName": "Balsa",
"clientVersion": "1.47.0.2493",
"deviceId": "browser7-4036-55de-ebdb-7246e1e66894"
},
"formType": "Quick",
"brandId": 12345,
"facilities": {
"facilities": [],
"areas": []
},
"location": {
"facilities": [],
"areas": []
},
"message": {
"priority": "NonEmergency",
"basic": {
"subject": "Example Subject",
"message": "Example Message",
"messageBody": "Example Message"
},
"files": [],
"language": "en-us",
"translate": true
},
"recipients": {
"uniqueMyAlertsAppCount": 0,
"uniqueEtnCount": 0,
"uniqueGroupCount": 1,
"uniqueContactCount": 3,
"selectedContactCount": 2,
"selectedGroupCount": 1,
"groupIds": [
556677
],
"mandatoryGroupIds": [],
"contactIds": [
12345,
67890
],
"groups": [],
"contacts": [],
"directories": [],
"distributionListId": "2b89d861-b26a-404f-a341-ca94645c3efg",
"searchFilters": []
},
"schedule": {
"scheduled": false,
"duration": 120,
"type": "Balsa"
},
"sender": {
"id": 0,
"asset": {
"id": "9c2d6b29658947058a2ebcdf35ded4b4",
"name": "Corporate Office"
},
"displayName": "Alton Ballard",
"email": "alton.ballard@konexus.com"
},
"hidden": false,
"publicAlert": false,
"weatherAlert": false,
"requestConfirmation": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"fields": [
{
"name": "template",
"required": false,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "priority",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "message",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": true,
"autofill": false
},
{
"name": "attachments",
"required": false
}
]
},
"async": true
}
{
"AlertId": 123456,
"SentStatus": {
"AlertId": 123456,
"AlertType": "QuickAlert",
"AlertStatus": "Queued",
"RecipientCount": 0,
"DateSent": "/Date(1752263762906-0000)/",
"DateCompleted": "/Date(-62135596800000-0000)/",
"TimeZone": "MT ",
"SenderName": "Alton Ballard",
"SenderEmail": "alton.ballard@konexus.com",
"Subject": "Example Subject",
"Message": "Example Message",
"Cancelled": false,
"Scheduled": false,
"Attachments": [],
"Source": "api",
"Sent": false,
"AlertCompletion": "Processing",
"Groups": [],
"Statuses": [],
"Errors": []
},
"Status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"HasErrors": false,
"IsValid": true
}
5. Retrieve Alert Details
POST - /v2/alerts/find
{
"page": 1,
"pageSize": 25,
"hidden": false,
"loadPollResults": false,
"alertStatuses": [
"New",
"Queued",
"Processing",
"Sent",
"Canceled"
],
"sort": "-sent"
}
{
"totalItemCount": 2,
"pageCount": 1,
"page": 1,
"pageSize": 25,
"items": [
{
"alertType": "Default",
"capXml": "",
"channels": {
"email": {
"requestConfirmation": false,
"send": true
},
"fax": {
"send": false
},
"push": {
"send": true
},
"textMessage": {
"primary": true,
"secondary": true,
"deliveryMethod": "Sms",
"send": true,
"message": "Alton Ballard: Example Message"
},
"voice": {
"cellPhone": false,
"businessPhone": false,
"homePhone": false,
"useOptOut": false,
"send": false
},
"facebook": {
"accountIds": [],
"pageIds": [],
"send": false
},
"twitter": {
"accountIds": [],
"send": false
},
"nextdoor": {
"accounts": [],
"send": false
},
"mobileBroadcast": {
"send": false
},
"myAlertsApp": {
"send": false
},
"microsoftTeams": {
"send": false
}
},
"clientContext": {
"isResend": true,
"platform": "Web",
"clientId": "io.alertsense.dev.apps",
"clientName": "Balsa",
"clientVersion": "1.47.0.2493",
"deviceId": "browser7-4036-55de-ebdb-7246e1e66894"
},
"formType": "Quick",
"brandId": 234234,
"id": 1233572,
"location": {
"point": {
"lat": 44.6609967,
"lng": -116.4396272
}
},
"message": {
"priority": "NonEmergency",
"basic": {
"subject": "Example Subject",
"message": "Example Message",
"messageBody": "Example Message"
},
"language": "en-us",
"translate": true,
"expireDateTimeUtc": "/Date(1752273045480+0000)/"
},
"recipients": {
"uniqueMyAlertsAppCount": 0,
"uniqueEtnCount": 0,
"uniqueGroupCount": 1,
"uniqueContactCount": 0,
"selectedContactCount": 0,
"selectedGroupCount": 0,
"groupIds": [
265850
],
"mandatoryGroupIds": [],
"contactIds": [
221974,
221977
],
"groups": [],
"contacts": [],
"directories": []
},
"related": [],
"schedule": {
"scheduled": false,
"expireDateTimeUtc": "/Date(1752273045480+0000)/",
"type": "Hickory"
},
"security": {
"requireAuthentication": false,
"voicePin": ""
},
"sender": {
"id": 98627,
"asset": {
"id": "9c2d6b29658947058a2ebcdf35ded4c9",
"name": "Corporate Office",
"externalId": "android-test-asset-0001"
},
"displayName": "Alton Ballard",
"email": "alton.ballard@konexus.com",
"externalId": "android-test-member-0042"
},
"timeSent": "/Date(1752265845347-0000)/",
"hidden": false,
"completionStatus": {
"id": 1233572,
"alertCompletion": "Sent",
"status": "Sent"
},
"publicAlert": false,
"weatherAlert": false,
"requestConfirmation": false,
"relatedAlertActions": {
"disableReplyAll": false
}
},
{
"alertType": "Default",
"capXml": "",
"channels": {
"email": {
"requestConfirmation": false,
"send": true
},
"fax": {
"send": false
},
"push": {
"send": true
},
"textMessage": {
"primary": true,
"secondary": true,
"deliveryMethod": "Sms",
"send": true,
"message": "Alton Ballard: Example Message"
},
"voice": {
"cellPhone": false,
"businessPhone": false,
"homePhone": false,
"useOptOut": false,
"send": false
},
"facebook": {
"accountIds": [],
"pageIds": [],
"send": false
},
"twitter": {
"accountIds": [],
"send": false
},
"nextdoor": {
"accounts": [],
"send": false
},
"mobileBroadcast": {
"send": false
},
"myAlertsApp": {
"send": false
},
"microsoftTeams": {
"send": false
}
},
"clientContext": {
"isResend": false,
"platform": "Web",
"clientId": "io.alertsense.dev.apps",
"clientName": "Balsa",
"clientVersion": "1.47.0.2493",
"deviceId": "browser7-4036-55de-ebdb-7246e1e66894"
},
"formType": "Quick",
"brandId": 234234,
"id": 1233394,
"location": {
"point": {
"lat": 44.6609967,
"lng": -116.4396272
}
},
"message": {
"priority": "NonEmergency",
"basic": {
"subject": "Example Subject",
"message": "Example Message",
"messageBody": "Example Message"
},
"language": "en-us",
"translate": true,
"expireDateTimeUtc": "/Date(1752270963547+0000)/"
},
"recipients": {
"uniqueMyAlertsAppCount": 0,
"uniqueEtnCount": 0,
"uniqueGroupCount": 1,
"uniqueContactCount": 0,
"selectedContactCount": 0,
"selectedGroupCount": 0,
"groupIds": [
265850
],
"mandatoryGroupIds": [],
"contactIds": [
221974,
221977
],
"groups": [],
"contacts": [],
"directories": []
},
"related": [],
"schedule": {
"scheduled": false,
"expireDateTimeUtc": "/Date(1752270963547+0000)/",
"type": "Hickory"
},
"security": {
"requireAuthentication": false,
"voicePin": ""
},
"sender": {
"id": 98627,
"asset": {
"id": "9c2d6b29658947058a2ebcdf35ded4c9",
"name": "Corporate Office",
"externalId": "android-test-asset-0001"
},
"displayName": "Alton Ballard",
"email": "alton.ballard+1166@nagdom.com",
"externalId": "android-test-member-0042"
},
"timeSent": "/Date(1752263763200-0000)/",
"hidden": false,
"completionStatus": {
"id": 1233394,
"alertCompletion": "Sent",
"status": "Sent"
},
"publicAlert": false,
"weatherAlert": false,
"requestConfirmation": false,
"relatedAlertActions": {
"disableReplyAll": false
}
}
],
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}