Create Alert
Create an alert that periodically polls an endpoint and delivers new results to your configured receivers (webhook, email, and/or telegram).
Create Alert › Request Body
pathThe path of the desired endpoint.
A dictionary of arguments to call the endpoint with. Do not include 'start_timestamp' or 'end_timestamp' because the alert owns the polling window.
interval_minutesHow often (in minutes) the alert checks the endpoint. Must be a multiple of 5.
1 to 2 delivery targets. Duplicate targets are rejected.
Optional human label for the alert, unique per user. Defaults to the endpoint name plus an index if omitted.
Rolling lookback window (in minutes). Defaults to interval_minutes if omitted.
thresholdMinimum number of matching items in the window before the alert fires.
Create Alert › Responses
Successful Response
messageConfirmation message indicating successful creation of the alert.
alert_idThe unique identifier of the created alert.
nameThe resolved name of the alert (provided or auto-generated).
A sample of the payload envelope that will be delivered to each receiver.
Get Alerts
Retrieve all alerts for the authenticated user, including recent attempt and delivery history.
Get Alerts › Responses
Successful Response
alert_idUnique identifier for the alert.
nameHuman label for the alert.
statusCurrent status of the alert.
pathThe endpoint the alert polls.
The endpoint arguments.
interval_minutesHow often the alert checks the endpoint, in minutes.
lookback_minutesRolling lookback window, in minutes.
thresholdMinimum item count before the alert fires.
The configured delivery targets.
end_timestamp of the last successful delivery, or null.
Recent execution attempts (no payload).
Recent deliveries (includes payload).
created_atWhen the alert was created.