Alertus Alert Configuration

 

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.

HTTP Request Alert Service

 

Creating an Alert Profile

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.

Creating an Alert Profile

Click the [Add Alert Profile] button

Configuring Alerts

Configuring Alerts

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.

Rapid Activation

Add each Arreya Channel’s alert service you previously configured, to the list of delivery methods in the existing alert profile.

Alertus on Digital Signage

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.

Alertus Digital SignageAlertus Digital Signage

Alerts for Digital Signage

Click [Add Preset Alert]

Keep People Safe with Digital Signage Alerts

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.

Alertus Mass Alerts System

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

Alertus Alerts

Select your preset alert you previously configured.

Mass Notification System

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

Digital Signage Alerts

Alertus

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 API Reference

API Reference

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.

 

Authentication

Arreya’s API uses API keys to authenticate requests. Information on locating your API Key can be found at https://arreya.com/kb/how-to-find-your-arreya-api-key/

 

Alert

https://[YOUR CHANNEL].arreya.com/api/v1/channel/alert?apikey=[YOUR API KEY]
  • [YOUR CHANNEL] – The name of the Arreya channel you want to issue alerts for, information on locating your channel name can be found at https://arreya.com/kb/how-to-find-your-channel-name/
  • [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
ParameterDescription
iconOptional, available icons – https://fontawesome.com/v4.7/icons/
titleTitle text
messageMessage body
colorOptional, controls the text color
backgroundOptional, uses CSS color values, can also use images with CSS url property
timeoutHow long the message stays on the display. Send a timeout of 0 to clear any active alerts.
animationOptional, animate the icon using one of the animations from https://animate.style/
apiKeyYour channel API Key

Beep

Parameter ValueRangeDescription 
soundEffectbeepn/aThe sound effect you want to play during the alert.
soundPitch15000-10000Controls the pitch of the sound effect.
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.50.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.

Tap

ParameterValueRangeDescription 
soundEffecttapn/aThe sound effect you want to play during the alert.
soundPitch20000-10000Controls the pitch of the sound effect.
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.050.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.

Click

ParameterValueRangeDescription
soundEffectclickn/aThe sound effect you want to play during the alert.
soundPitch10000-10000Controls the pitch of the sound effect.
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.50.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.

Fire

ParameterValueRangeDescription
soundEffectfiren/aThe sound effect you want to play during the alert.
soundPitch28500-10000Controls the pitch of the sound effect.
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.50.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.

Intermittent Tone

ParameterValueRangeDescription
soundEffectintermittentTonen/aThe sound effect you want to play during the alert.
soundPitch8000-10000Controls the pitch of the sound effect.
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.50.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.

Continuous Tone

ParameterValueRangeDescription
soundEffectcontinuousTonen/aThe sound effect you want to play during the alert.
soundPitch15000-10000Controls the pitch of the sound effect.
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.020.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.
soundDuration0(∞)0-100The duration of the sound effect to be played.
timeout604800(1 week)0-??The duration of the alert.

Speech

ParameterValueRangeDescription
soundEffectspeechn/aThe sound effect you want to play during the alert.
soundTextThis-is-some-default-text.n/aThe text that will be spoken for the alert.
soundVoicePitch10.0-2.0Controls the pitch of the voice for text to speech
soundDelay00-100Delay the sound effect (in seconds) from when the alert is active.
soundVolume0.50.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls whether or not the sound effect loops for the duration of the alert.
soundRate10.1-10Represents the speed the text is spoken.

Audio File

ParameterValueRangeDescription
soundEffectaudioFilen/aThe sound effect you want to play during the alert.
soundUrlhttps://example.com/example.wavn/aThe audio file you want to play for the alert.
soundAudioVolume0.50.0-1.0Controls the volume of the sound effect.
soundLoopFALSETRUE/FALSEControls 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

How to find your Arreya API Key

Please contact Arreya Support for your API Key.

support@arreya.com

319-294-6671

Our service hours are 8am to 5pm central time zone Monday through Friday.