FalconryScale
DevelopersAPI reference

Mark an alert read

Marks one of the caller’s alerts as read. Already-read alerts are left as they are.

POST
/alerts/{alertId}/read

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Path Parameters

alertId*string

An alert's id, from list_alerts.

Lengthlength <= 64

Response Body

Mark an alert read

application/json
  1. response
ok*boolean
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/alerts/string/read'
Example Response
{
  "ok": true
}

List the caller's alerts

Returns the caller's notifications (weight-alert triggers, reminders, ...), newest first, cursor-paginated. Pass the previous page's `nextCursor` to continue.

Mark every alert read

Marks all of the caller’s unread alerts as read. Ask the user first if they have not seen them yet.