Alerts

About

Relay’s Alert APIs notify your Relay users of any urgent events. Whether you’re a hotel, and want to quickly alert your housekeeping team or you’re a hospital, and need to alert the EVS team when a room needs to be turned over - the Relay Alert API can make it happen.

With the Alerts API, notifications are sent to specified groups on your account with a custom Text-to-Speech message and, optionally, an acknowledgement. The API allows you to send notifications that are either an Alert or a Broadcast. Notifications are done through a simple HTTP API. This allows you to effortlessly integrate these notifications into your own platform with an HTTP request. For example, if you had a ticketing system, broadcasting a message on a group of devices every time a ticket is added is done with an HTTP request to the /broadcast endpoint at the time of ticket creation.

Learn more below about how you can create different groups on your account, as well as how to make these API calls.

Groups

Groups provide a way to organize the devices on your account.

A group is a set of one or more devices on your account. In order to create a group, simply navigate to your Relay Dash home page and click on the Groups section to the left. From there, you should see a Create Group option. After entering a name for your group, you should be able to see your empty group in the Groups section. After selecting your group, you can then use the Edit Membership option to the left to add or remove devices from the group. Follow along with the short tutorial below to create a group on your account.