Arreya Alert API

https://api.arreya.com/api/v1/channel/alert

Query parameters

Required

apikey

you will need to generate an api key for your channel to publish an alert.
https://arreya.com/kb/arreya-api/how-to-use-the-api-key-event-log-and-api-log

Optional

Content

title

Heading text shown at the top of the alert. Placeholder is ALERT. Value must be url encoded (example: spaces must be %20).

default: none

message

The main alert body text. If omitted, the device removes any active alert. Value must be url encoded (example: spaces must be %20).

default: none

icon

Font Awesome icon name (e.g. exclamation-triangle, bell, fire). Valid values can be found at https://fontawesome.com/v4.7/icons/

default: none

 Appearance

color

Text color of the alert. Applied as the container's color. Values can be hexadecimal RGB value or color name.

default: #ffffff (white)

background

Background color of the alert container. Values can be hexadecimal RGB value or color name.

default: #00ff00 (green)

animation

Animate.css animation name applied to the icon (e.g. bounce, flash, tada, fadeIn). Runs infinite. Valid values can be found at https://animate.style/

default: none

Scheduling / Timing

schedule

Schedule is the timing mode where it can be omitted or set to "duration", or "schedule". Controls which timing fields apply.

values: duration | schedule

default: none

timeout

How long the alert stays up.

No mode: Alerts do not have an expiration.

Duration mode: Alert duration defaults to 604800.

If the timeout is set to 0, the alert will deactivate the current alert.

range: 0 - 604800

default: 604800

timeoutUnit

Unit for timeout: "s" (seconds) or "ms" (milliseconds)

values: s | ms

default: s

startTime

Required if schedule mode is set to "schedule". When the alert should begin. If in the future, the device sets a timer to post the alert then.

endTime

Required if schedule mode is set to "schedule". When the alert should end. Used to compute the display duration; the alert only shows if now is before endTime.

Audio / Sound Effects

soundEffect

List of optional sound effects

values: file | intermittentTone | continuousTone | speech | audioFile | click | beep | tap

soundText

The text to speech

soundPitch

Pitch/frequency, range ~20–20000.

range: 20 - 20000

soundVoicePitch

Pitch of the spoken voice.

range: 0 - 2.0

soundVolume

Volume for generated tone/speech effects.

range: 0.01 - 1.0

soundAudioVolume

Volume specifically for the audioFile playback.

range: 0.01 - 1.0

 soundDelay

Delay before the sound plays.

range: 0 - 100

 soundDuration

How long the sound plays.

range: 0 - 100

 soundRate

Playback rate (speed) of the effect.

range: 1 - 100

 soundUrl

Url of and audio file

soundLoop

Whether the sound repeats.

values: true | false

Example:

https://api.arreya.com/api/v1/channel/alert?apikey={channel_apikey}&icon=exclamation-triangle&timout=10&background=red&title=Alert&message=Alert%20Test%20Message