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 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.