Skip to main content
GET
List alert notifications

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Query Parameters

alertRuleID
string

Filter to notifications of a single alert rule (format aru-<number>).

alertInstanceID
string

Filter to notifications of a single alert instance (format ain-<number>).

status
enum<string>

Filter by delivery status.

Available options:
pending,
sent,
failed
page
integer
default:1

The page number to retrieve for paginated results.

Example:

1

pageSize
integer
default:10

The number of items to return per page. Useful for pagination.

Example:

20

Response

Paginated list of alert notifications. Paging metadata is returned in X-Corbado-Page, X-Corbado-TotalPages, and X-Corbado-TotalItems response headers.

Maximum array length: 1000
id
string
required

Alert notification ID (format ano-<number>).

alertRuleID
string
required

Alert rule ID (format aru-<number>).

alertInstanceID
string
required

Alert instance ID (format ain-<number>).

transition
enum<string>
required
Available options:
firing,
resolved,
no_data,
error
channel
enum<string>
required
Available options:
email
target
string
required

Where this delivery went - an address, a URL or a routing key, depending on the integration.

status
enum<string>
required
Available options:
pending,
sent,
failed
createdMs
integer<int64>
required
updatedMs
integer<int64>
required
labels
object

The label set of the alert instance this row is about, resolved from alertInstanceID so the history can name the alert the way the alert list does. Absent for the ungrouped alert of a rule with no groupBy, which has no labels.

dedupeKey
string
errorMessage
string
sentMs
integer<int64>