Arreya API Reference: Automating Digital Signage Alerts

Authentication and Setup

How do I authenticate API requests?

Arreya uses a simple API Key mechanism to authenticate requests. You do not need complex OAuth flows; simply include your unique key in your request parameters.

• Locate Your API Key: You can find your specific API Key and view event logs by logging into your Arreya account and navigating to the support settings.
• Locate Your Channel Name: Your channel name (subdomain) is required for the endpoint URL. You can find this in your account dashboard.

Developer Note: Ensure you keep your API Key secure. Do not embed it in public-facing client-side code.

The Alert Endpoint

Endpoint: https://[YOUR CHANNEL].arreya.com/api/v1/channel/alert?apikey=[YOUR API KEY]

This endpoint supports GET requests, POST requests, and the submission of CAP (Common Alerting Protocol) XML. When triggered, the alert overlays your current content instantly.

Visual Alert Parameters

You can customize the look of the alert to ensure it grabs attention using the following parameters:

Parameter	Description
title	The main headline text of the alert.
message	The body text providing details.
icon	An icon name from the FontAwesome v4.7 library (e.g., exclamation-triangle).
animation	An animation style from Animate.style to draw the eye to the icon.
color	Controls the text color (CSS values supported).
background	Controls the background color or image (supports CSS color values or URL).
timeout	Duration (in seconds) the message stays on screen. Send 0 to clear active alerts immediately.

Audio and Sound Effects

Can I play sounds with my alerts?

Yes. The Arreya API supports various sound effects to ensure your message is heard as well as seen. You can configure pitch, volume, and looping for different auditory cues.

1. Standard Tones (Beep, Tap, Click)

Best for informational notifications or subtle prompts.

• soundEffect: beep, tap, or click.
• soundPitch: Controls the frequency (e.g., 10000 – 20000 range).
• soundVolume: Float value between 0.0 and 1.0.

2. Emergency Tones (Fire, Intermittent, Continuous)

Best for high-priority safety warnings.

• soundEffect: fire, intermittentTone, or continuousTone.
• soundDuration: (For Continuous Tone) Defines how long the sound plays explicitly (0-100).
• soundLoop: Set to TRUE to repeat the sound for the duration of the alert.

3. Text-to-Speech (TTS)

Best for dynamic messaging where specific details need to be read aloud.

• soundEffect: speech.
• soundText: The actual string of text to be spoken (e.g., “Severe-Weather-Warning”).
• soundRate: Controls the speed of the spoken voice (0.1 – 10).
• soundVoicePitch: Modulates the voice pitch (0.0 – 2.0).

4. Custom Audio Files

Best for branded sounds or pre-recorded announcements.

• soundEffect: audioFile.
• soundUrl: The direct URL to your hosted audio file (e.g., https://example.com/alarm.wav).

Example Request

You can test the API directly in your browser by constructing a URL with your parameters.

Sample URL:

HTTP

This request would trigger a red background alert with white text, a wobbling triangle icon, and the title “ALERT TESTING” that lasts for 15 seconds.

Frequently Asked Questions

Does Arreya support CAP XML?

Yes. The API supports POSTing CAP (Common Alerting Protocol) XML data to the alert endpoint. This is the industry standard for emergency management, allowing seamless integration with federal and local warning systems.

How do I clear an alert remotely?

To remove an alert before the timeout expires, send a new API request with the timeout parameter set to 0.

What happens if I don’t set a timeout?

If using the continuousTone sound effect, you can set a specific timeout (defaulting to 1 week if unspecified) to ensure the alert persists until acknowledged or cleared.