Alert device

Triggers an alert (buzzer) on a device by sending a command through the Courier service. If no duration is provided, the device's configured alert_duration setting is used, or a default of 5 seconds. Requires read permissions for the device's workspace.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the device

Query Params
boolean
Defaults to true

Whether to wait for the alert command to reach the device before responding. Defaults to true. Set to false for fire-and-forget behavior.

Body Params

Optional alert options. If omitted, the device's configured duration or the default (5 seconds) is used.

integer

How long the alert should be active, in seconds. Must be greater than 0. If omitted, the device's configured alert_duration setting is used, or a default of 5 seconds.

Responses
204

Alert sent successfully

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json