The HTTP Request Alert Service can be used to trigger an alert to override the content on your Arreya channel.
In your alertus console, navigate to Configure System then Alert Services.
Arreya recommends creating an Alert Service for each channel you wish to alert. You can add an alert service for each Alert Profile as well. Furthermore this enables you to change colors, icons and specific messaging for each Alert Profile.
Click the [Add Alert Service] button.
For the Service Type field, Select HTTP Request.
In the Name and Description field, name your alert profile and enter a description.
For the Activation HTTP Methods field, select GET or POST
In the Activation URL field, your URL can be built using the attributes defined in the Arreya API documentation under the Alert endpoint. Moreover attributes encoded as URL form data will be overwritten if redefined in the request body.
Example Activation URL:
https://[YOUR CHANNEL].arreya.com/api/v1/channel/alert?apikey=[YOUR API KEY]&icon=exclamation-triangle&message=This%20is%20a%20test&background=red&color=white&title=ALERT%20TESTING& timeout=15&animation=wobble
For the Activation Body field, you can override fields defined in the Activation URL field. For example if you wanted to override the message in the alert, with the alert text from Alertus, enter the following in the Activation Body field
{ “message”:”${alert.text}”, }
A copy of available placeholder variables are available below.
Variable
Description
${alert.id}
Numerical ID of the Alertus Message
${alert.clientName}
Name of the client application that sent the alert
${alert.durationMillis}
Duration of the alert in milliseconds
${alert.expirationDate}
Time the alert expires in MM/dd/yyyy hh:mm:ss a format.
${alert.expirationDateUtc}
UTC time the alert expires in yyyy-MM-dd’T’HH:mm:ss’-00:00′ format
${alert.originId}
Unique identifier of the event that initiated the alert. For CAP alerts derived from CAP Alerts this is the CAP Identifier.
${alert.sender}
Name of the person or system that sent the alert
${alert.sentDate}
Time the alert was sent in MM/dd/yyyy hh:mm:ss a format.
${alert.sentDateUtc}
UTC time the alert was sent in yyyy-MM-dd’T’HH:mm:ss’-00:00′ format
${alert.text}
Alert message text.
More information regarding the HTTP Request Alert Service and additional fields can be found in your Alertus Documentation.
Arreya works with hosted/cloud versions of Alertus. On premise solutions may require additional configuration to access the outside web. Alerts can be triggered on your Arreya channel by Alertus in a few different ways.
Setting up Alert Services
First, you will need to set up one or more Alert Services for each service you wish to issue an alert for. For example this can be a HTTP request for each channel, or other services like RSS/XML to use with the RSS widget. Articles for each supported Alert Service are listed below.
Once you have added all of the channels you wish to alert to the Alert Services section, you can add an Alert profile to alert multiple channels at once.
In your alertus console, navigate to Configure System then Alert Profiles.
Click the [Add Alert Profile] button
For the Name and Description field, name your alert profile and enter a description.
Under the Delivery Methods section, add each alert service that you wish to alert with this profile. This will be all of the Arreya channels you previously added as Alert Services.
Click [Add Alert Profile] when you are done adding services.
Rapid Activation
If you wish to have your Arreya channels alerted in the event of a rapid activation, locate the alert profile named EMERGENCY. Click edit next to this alert profile.
Add each Arreya Channel’s alert service you previously configured, to the list of delivery methods in the existing alert profile.
Click [Save Alert Profile] when you are done adding services.
Preset Alerts
A Preset Alert will allow you to alert all of your Arreya channels at once.
In your alertus console, navigate to Configure System, then Preset Alerts.
Click [Add Preset Alert]
For the Name and Description field, name your alert preset and enter a description.
In the Compose Message section, you can enter a default message, this can be overridden when you issue the alert.
For the Specify Delivery Methods section, select the alert profile that you created for your Arreya channels.
Click [Add Preset Alert] when you are done
Additional presets can be added for different kinds of Alerts, fire, evacuation, etc.
Issuing an Alert: Preset Activation
In your alertus console, navigate to Preset Activation
Select your preset alert you previously configured.
In the Text field, you can change the message from the preset default.
Click [Continue] and follow the instructions to issue the alert.
Issuing an Alert: Custom Activation
In your alertus console, navigate to Custom Activation
In the Text field, you can enter the message the Alert will display.
For the Duration field, you can set a custom duration for the alert to display for.
Under Specify Delivery Methods, select the alert profile you previously configured for your Arreya channels. Or specify individual alert services if you want to alert specific Arreya channels.
Click [Continue] and follow the instructions to issue the alert.
Arreya offers a REST style API. Our API has accepts URL encoded data, form-encoded request bodies, JSON formatted bodies, and uses standard HTTPS responses and authentication.
[YOUR API KEY] – The API key for the channel you want to issue alerts for
Supports GET and POST requests
Supports POST of CAP xml
Supports parameters as url parameters, form data, or JSON post
Parameter
Description
icon
Optional, available icons – https://fontawesome.com/v4.7/icons/
title
Title text
message
Message body
color
Optional, controls the text color
background
Optional, uses CSS color values, can also use images with CSS url property
timeout
How long the message stays on the display. Send a timeout of 0 to clear any active alerts.
animation
Optional, animate the icon using one of the animations from https://animate.style/
apiKey
Your channel API Key
Beep
Parameter
Value
Range
Description
soundEffect
beep
n/a
The sound effect you want to play during the alert.
soundPitch
1500
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Tap
Parameter
Value
Range
Description
soundEffect
tap
n/a
The sound effect you want to play during the alert.
soundPitch
2000
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.05
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Click
Parameter
Value
Range
Description
soundEffect
click
n/a
The sound effect you want to play during the alert.
soundPitch
1000
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Fire
Parameter
Value
Range
Description
soundEffect
fire
n/a
The sound effect you want to play during the alert.
soundPitch
2850
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Intermittent Tone
Parameter
Value
Range
Description
soundEffect
intermittentTone
n/a
The sound effect you want to play during the alert.
soundPitch
800
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Continuous Tone
Parameter
Value
Range
Description
soundEffect
continuousTone
n/a
The sound effect you want to play during the alert.
soundPitch
1500
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.02
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
soundDuration
0(∞)
0-100
The duration of the sound effect to be played.
timeout
604800(1 week)
0-??
The duration of the alert.
Speech
Parameter
Value
Range
Description
soundEffect
speech
n/a
The sound effect you want to play during the alert.
soundText
This-is-some-default-text.
n/a
The text that will be spoken for the alert.
soundVoicePitch
1
0.0-2.0
Controls the pitch of the voice for text to speech
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
soundRate
1
0.1-10
Represents the speed the text is spoken.
Audio File
Parameter
Value
Range
Description
soundEffect
audioFile
n/a
The sound effect you want to play during the alert.
soundUrl
https://example.com/example.wav
n/a
The audio file you want to play for the alert.
soundAudioVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Example request URL:
https://[YOUR CHANNEL].arreya.com/api/v1/channel/alert?apikey=[YOUR API KEY]&icon=exclamation-triangle&message=This%20is%20a%20test&background=red&color=white&title=ALERT%20TESTING& timeout=15&animation=wobble
You can run this simple test in your browser by inserting your API key and your channel name
Click the green [+New Alert] button in the box on the left titled “Alerts”
In the new box that shows up you can set your alert with different messaging, animations, colors, and icons. You can also set how long you’d like the alert to display.
The Title field will display in larger text.
Message field is slightly smaller, intended for secondary messaging to the alert.
The icon drop down has many icons you can choose from to match the type of alert you are sending out.
The Animation drop down adds motion to bring attention to your alert. This will animate the icon. (Optional)
The timeout option will automatically remove the alert after the set amount of time, entered in seconds. It is default set to 500 seconds.
Click [Add Alert]
Your alert will now cover the screen and scroll across to attract attention